# CHORUS-API / PISTE.GOUV.FR
# chorus-api [](https://pepy.tech/project/chorus-api)
Chorus API Package [https://piste.gouv.fr](https://piste.gouv.fr)
## How to install chorus-api
# Install
```shell
pip install chorus-api
```
## 1.0.4
#### CHANGES
`Integration de l'état courant`
* Le service ConsulterCR permet de consulter les informations liées au dépôt d'un flux et de récupérer au format PDF le
compte rendu de traitement du flux déposé via le portail ou le service exposé DeposerFluxFacture.
| Key | code | description |
|--------------------------------|--------------------------------|--------------------------------------------------------------------------------------------------|
| IN_RECU | IN_RECU | Le flux a été reçu par Chorus Pro |
| IN_TRAITE_SE_CPP | IN_TRAITE_SE_CPP | Le fichier arrivé dans le système d’échange Chorus Pro |
| IN_EN_ATTENTE_TRAITEMENT_CPP | IN_EN_ATTENTE_TRAITEMENT_CPP | Le flux est en liste d’attente |
| IN_EN_COURS_TRAITEMENT_CPP | IN_EN_COURS_TRAITEMENT_CPP | Le flux est en cours de traitement |
| IN_INCIDENTE | IN_INCIDENTE | Flux non traité par le système d’échange, il sera nécessaire de reprendre le flux intégralement. |
| IN_REJETE | IN_REJETE | Le flux a été traité mais rejeté car il comporte des anomalies |
| IN_EN_ATTENTE_RETRAITEMENT_CPP | IN_EN_ATTENTE_RETRAITEMENT_CPP | Le flux a été bloqué, il attend une reprise manuelle |
| IN_INTEGRE | IN_INTEGRE | Le flux a été traité et tout a été intégré dans Chorus Pro. |
| IN_INTEGRE_PARTIEL | IN_INTEGRE_PARTIEL | Cela concerne des flux qui sont en rejet partiel, seules les factures correctes sont intégrées. |
# Usage
* [GET TOKEN](exemples/get_token.py)
```python
from chorusapi.client import ChorusAPI
from exemples.env import CLIENT_ID, CLIENT_SECRET
chorus_api = ChorusAPI(
client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
token = chorus_api.auth().get_token()
print(token)
```
* [Consulter les informations liées au dépôt d'un flux](exemples/status_depot.py)
```python
from chorusapi.client import ChorusAPI
from exemples.env import CLIENT_ID, CLIENT_SECRET, TECH_USERNAME, TECH_PASSWORD
chorus_api = ChorusAPI(
client_id=CLIENT_ID,
client_secret=CLIENT_SECRET,
tech_username=TECH_USERNAME,
tech_password=TECH_PASSWORD
)
status_depot = chorus_api.auth().consulter_cr("CPP0XXXXXXXXXXXXX")
print(status_depot.__dict__)
```
## More details in [examples](exemples) folders
Raw data
{
"_id": null,
"home_page": "https://github.com/cnfilms/chorus-api",
"name": "chorus-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7",
"maintainer_email": "",
"keywords": "python,chorus,api,piste,chorus piste",
"author": "Joel ONIPOH",
"author_email": "technique@cinego.net",
"download_url": "https://files.pythonhosted.org/packages/32/53/d244be73570277f330cdd89e34a910307ce9921cbaaa276446e60cfd5f8b/chorus-api-1.0.4.tar.gz",
"platform": null,
"description": "# CHORUS-API / PISTE.GOUV.FR\n\n# chorus-api [](https://pepy.tech/project/chorus-api)\n\nChorus API Package [https://piste.gouv.fr](https://piste.gouv.fr)\n\n## How to install chorus-api\n\n# Install\n\n```shell\npip install chorus-api\n```\n\n## 1.0.4\n\n#### CHANGES\n\n`Integration de l'\u00e9tat courant`\n\n* Le service ConsulterCR permet de consulter les informations li\u00e9es au d\u00e9p\u00f4t d'un flux et de r\u00e9cup\u00e9rer au format PDF le\n compte rendu de traitement du flux d\u00e9pos\u00e9 via le portail ou le service expos\u00e9 DeposerFluxFacture.\n\n| Key | code | description |\n|--------------------------------|--------------------------------|--------------------------------------------------------------------------------------------------|\n| IN_RECU | IN_RECU | Le flux a \u00e9t\u00e9 re\u00e7u par Chorus Pro |\n| IN_TRAITE_SE_CPP | IN_TRAITE_SE_CPP | Le fichier arriv\u00e9 dans le syst\u00e8me d\u2019\u00e9change Chorus Pro |\n| IN_EN_ATTENTE_TRAITEMENT_CPP | IN_EN_ATTENTE_TRAITEMENT_CPP | Le flux est en liste d\u2019attente |\n| IN_EN_COURS_TRAITEMENT_CPP | IN_EN_COURS_TRAITEMENT_CPP | Le flux est en cours de traitement |\n| IN_INCIDENTE | IN_INCIDENTE | Flux non trait\u00e9 par le syst\u00e8me d\u2019\u00e9change, il sera n\u00e9cessaire de reprendre le flux int\u00e9gralement. |\n| IN_REJETE | IN_REJETE | Le flux a \u00e9t\u00e9 trait\u00e9 mais rejet\u00e9 car il comporte des anomalies |\n| IN_EN_ATTENTE_RETRAITEMENT_CPP | IN_EN_ATTENTE_RETRAITEMENT_CPP | Le flux a \u00e9t\u00e9 bloqu\u00e9, il attend une reprise manuelle |\n| IN_INTEGRE | IN_INTEGRE | Le flux a \u00e9t\u00e9 trait\u00e9 et tout a \u00e9t\u00e9 int\u00e9gr\u00e9 dans Chorus Pro. |\n| IN_INTEGRE_PARTIEL | IN_INTEGRE_PARTIEL | Cela concerne des flux qui sont en rejet partiel, seules les factures correctes sont int\u00e9gr\u00e9es. |\n\n# Usage\n\n* [GET TOKEN](exemples/get_token.py)\n\n```python\nfrom chorusapi.client import ChorusAPI\nfrom exemples.env import CLIENT_ID, CLIENT_SECRET\n\nchorus_api = ChorusAPI(\n client_id=CLIENT_ID,\n client_secret=CLIENT_SECRET\n)\n\ntoken = chorus_api.auth().get_token()\nprint(token)\n```\n\n* [Consulter les informations li\u00e9es au d\u00e9p\u00f4t d'un flux](exemples/status_depot.py)\n\n```python\nfrom chorusapi.client import ChorusAPI\nfrom exemples.env import CLIENT_ID, CLIENT_SECRET, TECH_USERNAME, TECH_PASSWORD\n\nchorus_api = ChorusAPI(\n client_id=CLIENT_ID,\n client_secret=CLIENT_SECRET,\n tech_username=TECH_USERNAME,\n tech_password=TECH_PASSWORD\n)\n\nstatus_depot = chorus_api.auth().consulter_cr(\"CPP0XXXXXXXXXXXXX\")\nprint(status_depot.__dict__)\n```\n\n## More details in [examples](exemples) folders\n",
"bugtrack_url": null,
"license": "",
"summary": "Chorus API Package https://piste.gouv.fr",
"version": "1.0.4",
"project_urls": {
"Bug Tracker": "https://github.com/cnfilms/chorus-api/issues",
"Changelog": "https://github.com/cnfilms/chorus-api/releases",
"Homepage": "https://github.com/cnfilms/chorus-api"
},
"split_keywords": [
"python",
"chorus",
"api",
"piste",
"chorus piste"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc5934cf5643d5db901362e23b414667acaa3ce23869765b22226efee76196e8",
"md5": "af667556eae1e5019830738da37c2de2",
"sha256": "b40db6d3c7cee78dffc459276acd67fa67203e6ffac2d42473e2d8feb15ee6e8"
},
"downloads": -1,
"filename": "chorus_api-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af667556eae1e5019830738da37c2de2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=2.7",
"size": 17023,
"upload_time": "2023-08-23T11:24:15",
"upload_time_iso_8601": "2023-08-23T11:24:15.139523Z",
"url": "https://files.pythonhosted.org/packages/dc/59/34cf5643d5db901362e23b414667acaa3ce23869765b22226efee76196e8/chorus_api-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3253d244be73570277f330cdd89e34a910307ce9921cbaaa276446e60cfd5f8b",
"md5": "00b0cd25433a164d3adb5f533545c95a",
"sha256": "731e098898bac5ebb247492aff64f3654d5163849dfe0d4c54b625bf437624af"
},
"downloads": -1,
"filename": "chorus-api-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "00b0cd25433a164d3adb5f533545c95a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 24276,
"upload_time": "2023-08-23T11:24:16",
"upload_time_iso_8601": "2023-08-23T11:24:16.272985Z",
"url": "https://files.pythonhosted.org/packages/32/53/d244be73570277f330cdd89e34a910307ce9921cbaaa276446e60cfd5f8b/chorus-api-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-23 11:24:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cnfilms",
"github_project": "chorus-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "chorus-api"
}
JSON
