57 lines
1.7 KiB
Plaintext
57 lines
1.7 KiB
Plaintext
authentic2-cut
|
|
==============
|
|
|
|
Authentic2 plugin for CUT
|
|
|
|
Installation
|
|
------------
|
|
|
|
Install with `pip install authentic2-cut`
|
|
|
|
Code Style
|
|
==========
|
|
|
|
black is used to format the code, using thoses parameters:
|
|
|
|
black --target-version py37 --skip-string-normalization --line-length 110
|
|
|
|
There is .pre-commit-config.yaml to use pre-commit to automatically run black
|
|
before commits. (execute `pre-commit install` to install the git hook.)
|
|
|
|
isort is used to format the imports, using those parameter:
|
|
|
|
isort --profile black --line-length 110
|
|
|
|
pyupgrade is used to automatically upgrade syntax, using those parameters:
|
|
|
|
pyupgrade --keep-percent-format --py37-plus
|
|
|
|
There is .pre-commit-config.yaml to use pre-commit to automatically run black,
|
|
isort and pyupgrade before commits. (execute `pre-commit install` to install
|
|
the git hook.)
|
|
|
|
Settings
|
|
========
|
|
|
|
Register the plugin in your settings file.
|
|
|
|
INSTALLED_APPS += ('sorl.thumbnail', 'authentic2_cut',)
|
|
TENANT_APPS += ('sorl.thumbnail', 'authentic2_cut',)
|
|
MIDDLEWARE += ('authentic2_cut.middlewares.CUTMiddleware',)
|
|
|
|
License
|
|
-------
|
|
|
|
This program is free software: you can redistribute it and/or modify it under
|
|
the terms of the GNU Affero General Public License as published by the Free
|
|
Software Foundation, either version 3 of the License, or (at your option) any
|
|
later version.
|
|
|
|
This program is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
|
|
PARTICULAR PURPOSE. See the GNU Affero General Public License for more
|
|
details.
|
|
|
|
You should have received a copy of the GNU Affero General Public License along
|
|
with this program. If not, see <http://www.gnu.org/licenses/>.
|