A compilation of the applications we often use in addition to Django Rest Framework
Project description
PixelForest DRF
This repository host the code of the PixelForest DRF package. This package will host most of the reusable applications/code we use on a project basis as the PixelForest Dev Team.
Note This package is under public licensing because we figured it might be useful for other as it is.
Current applications
- None
Getting started
Requirements
The following requirements will need to be installed and configured
Installation
You can install the package using pip
pip install pixelforest_drf
Add the wanted application(s) to your INSTALLED_APPS
:
INSTALLED_APPS = (
...
"pixelforest_drf.countries.apps.CountriesConfig",
...
)
Add the wanted URL patterns:
from pixelforest_drf.countries import urls as countries_urls
urlpatterns = [
...
path('', include(countries_urls)),
...
]
Contributing
Guidelines
Please contact the PixelForest Dev Team for any bug report or feature request.
Development Requirements
You will need to install setuptools
, twine
and wheel
pip install setuptools twine wheel
Add a new subpackage
To add a new subpackages, first create it under the pixelforest_drf directory. The only necessary files are:
- apps.py (with a properly configured Config)
- urls.py (with at least an empty urlpatterns list)
- requirements.txt
To add this application to the global package, you need to modify the test files:
- tests/settings.py - Add the new application to INSTALLED_APPS
- tests/urls.py - Add the new application urls to the url_patterns
Also, modify the global requirements.txt to link the requirements from the new package.
Publish to PyPi
First, generate the new distributions archives
python setup.py sdist bdist_wheel
Then, after testing it locally, upload it directly to PyPi. You'll need the credentials of the pixelforest PyPi user for this operation.
twine upload dist/*
Contributors
Jean-Xavier Raynaud - email - Product Owner / System Architect / Developer
Milo Parigi - email - Scrum Master / Developer
Victor Duvernois - email - Developer
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 pixelforest_drf-0.0.dev3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 642c03f0a38559ddc8eedef4566ff8d114b41fcf1f0d690ff8ba44d2c375630b |
|
MD5 | a2d93323689b73dc2729c40012d48353 |
|
BLAKE2b-256 | ea084cce1ab8c27e98e3e7353acde237ba7ceccb9178002ce4c63f5a5edb80d5 |