Welcome to Flask-Echelon’s documentation!¶
Flask-Echelon provides a simple, hierarchical permissions tool. Ideal for Blueprints.
- Free software: MIT license
- Documentation: https://flask-echelon.readthedocs.io.
To install Flask-Echelon, run this command in your terminal:
$ pip install flask_echelon
This is the preferred method to install Flask-Echelon, as it will always install the most recent stable release.
The sources for Flask-Echelon can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone git://github.com/jesseops/flask_echelon
Or download the tarball:
$ curl -OL https://github.com/jesseops/flask_echelon/tarball/master
Once you have a copy of the source, you can install it with:
$ python setup.py install
To use Flask-Echelon in a project:
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report bugs at https://github.com/jesseops/flask_echelon/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
Flask-Echelon could always use more documentation, whether as part of the official Flask-Echelon docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/jesseops/flask_echelon/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Ready to contribute? Here’s how to set up flask_echelon for local development.
Fork the flask_echelon repo on GitHub.
Clone your fork locally:
$ git clone email@example.com:your_name_here/flask_echelon.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv flask_echelon $ cd flask_echelon/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 flask_echelon tests $ python setup.py test or py.test $ tox
To get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/jesseops/flask_echelon/pull_requests and make sure that the tests pass for all supported Python versions.
To run a subset of tests:
$ py.test tests.test_flask_echelon