Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jerivas committed Aug 18, 2020
1 parent b3f66bc commit 73d0971
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ Overview

filebrowser_safe is a permanent fork of
`FileBrowser asset manager <https://github.com/sehmaschine/django-filebrowser>`_
for `Django <http://www.djangoproject.com/>`_, to be referenced as a
dependency for the `Mezzanine CMS for Django <http://mezzanine.jupo.org/>`_.
for `Django <https://www.djangoproject.com/>`_, to be referenced as a
dependency for the `Mezzanine CMS for Django <https://mezzanine.jupo.org/>`_.

At the time of filebrowser_safe's creation, FileBrowser was incorrectly
packaged on `PyPI <http://pypi.python.org/pypi>`_, and had also dropped
packaged on `PyPI <https://pypi.python.org/pypi>`_, and had also dropped
compatibility with Django 1.1 -- filebrowser_safe was therefore created to
address these specific issues.

For further details, see
`Why are Grappelli and Filebrowser Forked? <http://mezzanine.jupo.org/docs/frequently-asked-questions.html#grappelli-filebrowser-forks>`_.
`Why are Grappelli and Filebrowser Forked? <https://mezzanine.jupo.org/docs/frequently-asked-questions.html#grappelli-filebrowser-forks>`_.

Development
===========
Expand All @@ -23,6 +23,10 @@ After cloning the repository, install the package with the extra testing require
.. code-block:: bash
pip install -e ".[testing]"
tox # Use the --parallel option to run tests in parallel
tox # Use the --parallel option to run tests in parallel (faster)
You might get some ``InterpreterNotFound`` errors due to not having all Python versions available in your system. That's okay as long as you're able to successfully run the test suite for at least one Python version.

Python code is enforced with ``flake8`` and ``black``. ``tox`` will verify both for you. For your convenience you can run the command ``tox -e format`` to fix most (but not all) linter errors. Alternatively you can configure your code editor to lint and format according to the rules defined in ``setup.cfg`` to catch code style errors as you develop.

When you are ready to contribute your changes create and submit a pull request for review. This will run all tests in all supported Python versions and alert if any of them fail.

0 comments on commit 73d0971

Please sign in to comment.