Metadata-Version: 2.1
Name: dj_sinp_organisms
Version: 0.2.0
Summary: Django app to manage french SINP organisms standard
Home-page: https://github.com/dbchiro/DjangoSinpNomenclature
License: AGPLv3
Keywords: SINP,Nomenclatures,Django,France,dbChiroWeb
Author: dbChiro project
Author-email: project@dbchiro.org
Requires-Python: >=3.8.1,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: Django (>=3.2)
Requires-Dist: dj-sinp-nomenclatures (>=0.2.4,<0.3.0)
Requires-Dist: djangorestframework (>=3,<4)
Project-URL: Repository, https://github.com/dbchiro/DjangoSinpNomenclature
Description-Content-Type: text/x-rst

=========================
SINP Organisms for Django
=========================

`DjangoSinpOrganisms <https://github.com/dbchiro/DjangoSinpOrganisms>`_ is a simple `Django <https://www.djangoproject.com/>`_ reusable app to manage `French SINP Organisms <http://standards-sinp.mnhn.fr/referentiel-des-organismes/>`_, respecting standard.


Detailed documentation is in the "docs" directory.

Quick start
-----------

1. Install app

.. code-block:: bash

    $ pip install -U dj-sinp-organisms



2. Configure ``INSTALLED_APPS``:

.. code-block:: python

    INSTALLED_APPS = (
        'django.contrib.admin',
        'django.contrib.auth',
        (...),
        'rest_framework',
        'sinp_nomenclatures',
        'sinp_organisms',
        (...),
    )


3. Configure ``urls.py``:

.. code-block:: python

    urlpatterns = [
        path('admin/', admin.site.urls),
        path('api-auth/', include('rest_framework.urls')),
        (...),
        path('api/v1/', include('sinp_nomenclatures.urls')),
        path('api/v1/', include('sinp_organisms.urls')),
        (...),
    ]

4. Run ``python manage.py migrate`` to create the polls models.

5. Start the development server and visit http://127.0.0.1:8000/admin/
   to create an organism (you'll need the Admin app enabled).

6. Visit http://127.0.0.1:8000/api/v1/organisms to view organisms API.

