Code Monkey home page Code Monkey logo

core's Introduction

Brave Collective Core Services

An EVE online authentication and mediated API access application.

© 2013, Alice Bevan-McGregor and contributors.

https://github.com/bravecollective/core

1. What is Brave Collective Core?

  • User management.
  • EVE Online API key management.
  • Third-party application registration.
  • Authentication of users for third-party applications.
  • Authorization of EVE API access by users for third-party applications.
  • Access control list group/role definition for use by third-party applications.

2. Installation

Development takes place on GitHub in the core project. Issue tracking, documentation, and downloads are provided there.

You will require a current WebCore installation. The following line will create a new Python virtual environment folder called “brave” in your current working directory, then activate the virtual environment.

curl get.web-core.org | python - brave
cd brave
. bin/activate

Additionally, there are two requirements you will need to manually install as Core Services require features present in as-yet unreleased packages. You will need to perform the following steps:

(git clone [email protected]:marrow/marrow.templating.git; cd marrow.templating; python setup.py develop)
(git clone [email protected]:marrow/marrow.tags.git; cd marrow.tags; python setup.py develop)

Installing the current development version of the Core Service requires Git, a distributed source code management system. If you have Git, you can run the following to download and link the development version into your Python runtime:

git clone https://github.com/bravecollective/core.git
(cd core; python setup.py develop)

Once you have a copy of the code, copy `devlopment.ini` to `local.ini` and make changes as appropriate. Finally, bootstrap the EVE API system by running:

paster shell local.ini # or development.ini if you didn't customize
from adam.api import populate_calls
populate_calls()

You can upgrade to the latest version at any time:

(cd core; git pull; python setup.py develop)

If you would like to make changes and contribute them back to the project, fork the GitHub project, make your changes, and submit a pull request. This process is beyond the scope of this documentation; for more information, see GitHub’s documentation.

3. Running the Service

Make a copy of development.ini called local.ini, update all relevant directives (related to storage of sessions, cache data, and database URI) and run the following to serve content locally:

paster serve local.ini

This will start a development server and present the URL you need to access. (Generally http://127.0.0.1:8080.) If you wish the server to automatically restart in the event of a change to one of the source files (templates and statically served content are exempt) add the --reload switch.

4. License

Brave Collective Core Services has been released under the MIT Open Source license. All contributors agree to transfer ownership of their code to Alice Bevan-McGregor for release under this license. (This is to mitigate issues in the future.)

4.1. The MIT License

Copyright © 2013 Alice Bevan-McGregor and contributors.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

core's People

Contributors

amcgregor avatar mglinski avatar funi1234 avatar byetsniv avatar jpumford avatar lmorchard avatar

Watchers

James Cloos avatar

core's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.