Metadata-Version: 2.3
Name: dj_sinp_organisms
Version: 1.4.2
Summary: Django app to manage french SINP organisms standard
License: AGPLv3
Keywords: SINP,Nomenclatures,Django,France,dbChiroWeb
Author: dbChiro project
Requires-Python: >=3.9.0,<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
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: Django (>=3.2)
Requires-Dist: dj-sinp-nomenclatures (>=0.0.0)
Requires-Dist: djangorestframework (>=3,<4)
Project-URL: Documentation, https://dbchiro.github.io/DjangoSinpOrganisms/
Project-URL: Homepage, https://github.com/dbchiro/DjangoSinpOrganisms
Project-URL: Repository, https://github.com/dbchiro/DjangoSinpOrganisms
Description-Content-Type: text/markdown

# 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.

See docs for more details : <https://dbchiro.github.io/DjangoSinpOrganisms/>

## Quick start

1. Install app

```bash
pip install -U dj-sinp-organisms
```

2. Configure `INSTALLED_APPS`:

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

3. Configure `urls.py`:

```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.

## Database models

![models.png](./docs/_static/models.png)

