Ambient toolbox - Lots of helper functions and useful widgets
Project description
Overview
This package contains various useful helper functions. You can read up on all the fancy things at readthedocs.io.
Installation
-
Install the package via pip:
pip install ai-django-core
or via pipenv:
pipenv install ai-django-core
-
Add module to
INSTALLED_APPS
within the main djangosettings.py
:INSTALLED_APPS = ( ... 'ai_django_core', )
Contribute
Add functionality
- Clone the project locally
- Create a new branch for your feature
- Change the dependency in your requirements.txt to a local (editable) one that points to your local file system:
-e /Users/workspace/ai-django-core
or via pippip install -e /Users/workspace/ai-django-core
- Ensure the code passes the tests
- Create a pull request
Run tests
-
Check coverage
pytest --cov=.
-
Run tests
pytest
Update documentation
- To generate new auto-docs for new modules run:
sphinx-apidoc -o ./docs/modules/ ./ai_django_core/
(in the current set up an auto doc for the anti-virus module is not supported due to installation and import problems. Since it might be removed in the future, that should be fine for now). - To build the documentation run:
sphinx-build docs/ docs/_build/html/
or go into the docs folder and run:make html
. Opendocs/_build/html/index.html
to see the documentation.
Translation files
How to create translation file:
- Navigate to
ai_django_core/ai_django_core
(the inner directory!) django-admin makemessages -l de
- Have a look at the new/changed files within
ai_django_core/ai_django_core/locale
How to compile translation files:
- Navigate to
ai_django_core/ai_django_core
(the inner directory!) django-admin compilemessages
- Have a look at the new/changed files within
ai_django_core/ai_django_core/locale
Publish to ReadTheDocs.io
- Fetch the latest changes in github mirror and push them
- Trigger new build at ReadTheDocs.io (follow instructions in admin panel at RTD)
Publish to PyPi
-
Update documentation about new/changed functionality
-
Update the
Changelog
-
Increment version in main
__init__.py
-
Create pull request / merge to master
-
This project uses the flit package to publish to PyPI. Thus publishing should be as easy as running:
flit publish
To publish to TestPyPI use the following ensure that you have set up your .pypirc as shown here and use the following command:
flit publish --repository testpypi
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ai_django_core-5.7.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc451fe86741a50304089a2dc681ec54f2244887cd8389fddea935292db7aa75 |
|
MD5 | 2284effd449917b840f14830378281ec |
|
BLAKE2b-256 | e83f0f0917a172f8ce5b7672022f07593e9605cbbcf52c35701d9bd02aabdfea |