| Name | loadnsi JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | https://github.com/Friskes/loadnsi |
| Summary | Utility for downloading and updating NSI fixtures |
| upload_time | 2025-02-07 20:18:29 |
| maintainer | None |
| docs_url | None |
| author | Friskes |
| requires_python | >=3.10 |
| license | MIT License
Copyright (c) 2025 Friskes
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
django
fixture
nsi
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Утилита для загрузки и обновления фикстур НСИ
<div align="center">
| Project | | Status |
|-----------|:----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| CI/CD | | [](https://github.com/Friskes/loadnsi/actions/workflows/publish-to-pypi.yml) |
| Quality | | [](https://codecov.io/github/Friskes/loadnsi) |
| Package | | [](https://badge.fury.io/py/loadnsi)   |
| Meta | | [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/astral-sh/ruff) |
</div>
> Команда [loadnsi](#About-command) позволяет загружать и обновлять фикстуры [НСИ](https://nsi.rosminzdrav.ru) в которых записи имеют стабильный pk вашей внутренней системы бд.
## Подготовка к запуску
1. Установка пакета
```bash
pip install loadnsi
```
2. Создание файла переменных среды
.env файл с содержимым:
```bash
# Опционально, позволяет запускать команду из вложенных директорий проекта.
ABS_ROOT_DIR=C:/path/to/your/project/dir
PATH_TO_LOADNSI_CONFIG=path/to/your/config/file.py
# Опционально, требуется только если вы собираетесь использовать официальный API НСИ (Запуск команды с флагом `--use_official_api`).
NSI_API_USER_KEY=some-key
```
3. Создание файла конфигурации `loadnsi_config.py`
```python
NSI_FIXTURES_FOLDER = 'path/to/your/nsi/folder'
NSI_PASSPORTS = {
'file': 'Локальное название файла с паспортами справочников',
'model': 'Локальное название модели с паспортами справочников',
# Опциональные параметры (include, exclude):
'include': <Iterable объект состоящий из полей паспорта (str) которые необходимо оставить в объекте паспорта>,
'exclude': <Iterable объект состоящий из полей паспорта (str) которые необходимо исключить из объекта паспорта>,
}
DICT_INTERNAL_PK = 'your pk field name *not alias*'
PASSPORTS_REL = 'your fieldname for ForeignKey to PARENT_DICT_CLS'
PARENT_DICT_CLS = 'your base cls modelname for dicts'
NSI_DICTIONARIES = {
'Локальное название файла справочника 1': {
'model': 'Приложение.МодельСправочника1',
'oid': 'OID Справочника 1',
# Опциональные параметры (filter, include, exclude и create_sql):
'filter': <Callable объект принимает справочник (dict) должен вернуть (bool) оставлять ли этот объект в списке>,
'include': <Iterable объект состоящий из полей справочника (str) которые необходимо оставить в объекте справочника>,
'exclude': <Iterable объект состоящий из полей справочника (str) которые необходимо исключить из объекта справочника>,
'create_sql': <Boolean объект (bool), если True будет создан дублирующий файл справочника в SQL формате>,
},
'Локальное название файла справочника 2': {
'model': 'Приложение.МодельСправочника2',
'oid': 'OID Справочника 2',
},
}
```
## About command
Подробности про каждую опцию команды можно узнать вызвав команду с флагом `--help`
## Contributing
We would love you to contribute to `loadnsi`, pull requests are very welcome! Please see [CONTRIBUTING.md](https://github.com/Friskes/loadnsi/blob/main/CONTRIBUTING.md) for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/Friskes/loadnsi",
"name": "loadnsi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Django, Fixture, NSI",
"author": "Friskes",
"author_email": "Friskes <friskesx@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/49/62/6297d84b13556c9f9ee6bb93dc3fae14aa4ae9379897c19c05a3a2f07d5a/loadnsi-0.1.1.tar.gz",
"platform": null,
"description": "# \u0423\u0442\u0438\u043b\u0438\u0442\u0430 \u0434\u043b\u044f \u0437\u0430\u0433\u0440\u0443\u0437\u043a\u0438 \u0438 \u043e\u0431\u043d\u043e\u0432\u043b\u0435\u043d\u0438\u044f \u0444\u0438\u043a\u0441\u0442\u0443\u0440 \u041d\u0421\u0418\n\n<div align=\"center\">\n\n| Project | | Status |\n|-----------|:----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| CI/CD | | [](https://github.com/Friskes/loadnsi/actions/workflows/publish-to-pypi.yml) |\n| Quality | | [](https://codecov.io/github/Friskes/loadnsi) |\n| Package | | [](https://badge.fury.io/py/loadnsi)   |\n| Meta | | [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/astral-sh/ruff) |\n\n</div>\n\n> \u041a\u043e\u043c\u0430\u043d\u0434\u0430 [loadnsi](#About-command) \u043f\u043e\u0437\u0432\u043e\u043b\u044f\u0435\u0442 \u0437\u0430\u0433\u0440\u0443\u0436\u0430\u0442\u044c \u0438 \u043e\u0431\u043d\u043e\u0432\u043b\u044f\u0442\u044c \u0444\u0438\u043a\u0441\u0442\u0443\u0440\u044b [\u041d\u0421\u0418](https://nsi.rosminzdrav.ru) \u0432 \u043a\u043e\u0442\u043e\u0440\u044b\u0445 \u0437\u0430\u043f\u0438\u0441\u0438 \u0438\u043c\u0435\u044e\u0442 \u0441\u0442\u0430\u0431\u0438\u043b\u044c\u043d\u044b\u0439 pk \u0432\u0430\u0448\u0435\u0439 \u0432\u043d\u0443\u0442\u0440\u0435\u043d\u043d\u0435\u0439 \u0441\u0438\u0441\u0442\u0435\u043c\u044b \u0431\u0434.\n\n\n## \u041f\u043e\u0434\u0433\u043e\u0442\u043e\u0432\u043a\u0430 \u043a \u0437\u0430\u043f\u0443\u0441\u043a\u0443\n1. \u0423\u0441\u0442\u0430\u043d\u043e\u0432\u043a\u0430 \u043f\u0430\u043a\u0435\u0442\u0430\n ```bash\n pip install loadnsi\n ```\n\n2. \u0421\u043e\u0437\u0434\u0430\u043d\u0438\u0435 \u0444\u0430\u0439\u043b\u0430 \u043f\u0435\u0440\u0435\u043c\u0435\u043d\u043d\u044b\u0445 \u0441\u0440\u0435\u0434\u044b\n .env \u0444\u0430\u0439\u043b \u0441 \u0441\u043e\u0434\u0435\u0440\u0436\u0438\u043c\u044b\u043c:\n ```bash\n # \u041e\u043f\u0446\u0438\u043e\u043d\u0430\u043b\u044c\u043d\u043e, \u043f\u043e\u0437\u0432\u043e\u043b\u044f\u0435\u0442 \u0437\u0430\u043f\u0443\u0441\u043a\u0430\u0442\u044c \u043a\u043e\u043c\u0430\u043d\u0434\u0443 \u0438\u0437 \u0432\u043b\u043e\u0436\u0435\u043d\u043d\u044b\u0445 \u0434\u0438\u0440\u0435\u043a\u0442\u043e\u0440\u0438\u0439 \u043f\u0440\u043e\u0435\u043a\u0442\u0430.\n ABS_ROOT_DIR=C:/path/to/your/project/dir\n PATH_TO_LOADNSI_CONFIG=path/to/your/config/file.py\n # \u041e\u043f\u0446\u0438\u043e\u043d\u0430\u043b\u044c\u043d\u043e, \u0442\u0440\u0435\u0431\u0443\u0435\u0442\u0441\u044f \u0442\u043e\u043b\u044c\u043a\u043e \u0435\u0441\u043b\u0438 \u0432\u044b \u0441\u043e\u0431\u0438\u0440\u0430\u0435\u0442\u0435\u0441\u044c \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c \u043e\u0444\u0438\u0446\u0438\u0430\u043b\u044c\u043d\u044b\u0439 API \u041d\u0421\u0418 (\u0417\u0430\u043f\u0443\u0441\u043a \u043a\u043e\u043c\u0430\u043d\u0434\u044b \u0441 \u0444\u043b\u0430\u0433\u043e\u043c `--use_official_api`).\n NSI_API_USER_KEY=some-key\n ```\n\n3. \u0421\u043e\u0437\u0434\u0430\u043d\u0438\u0435 \u0444\u0430\u0439\u043b\u0430 \u043a\u043e\u043d\u0444\u0438\u0433\u0443\u0440\u0430\u0446\u0438\u0438 `loadnsi_config.py`\n ```python\n NSI_FIXTURES_FOLDER = 'path/to/your/nsi/folder'\n NSI_PASSPORTS = {\n 'file': '\u041b\u043e\u043a\u0430\u043b\u044c\u043d\u043e\u0435 \u043d\u0430\u0437\u0432\u0430\u043d\u0438\u0435 \u0444\u0430\u0439\u043b\u0430 \u0441 \u043f\u0430\u0441\u043f\u043e\u0440\u0442\u0430\u043c\u0438 \u0441\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u043e\u0432',\n 'model': '\u041b\u043e\u043a\u0430\u043b\u044c\u043d\u043e\u0435 \u043d\u0430\u0437\u0432\u0430\u043d\u0438\u0435 \u043c\u043e\u0434\u0435\u043b\u0438 \u0441 \u043f\u0430\u0441\u043f\u043e\u0440\u0442\u0430\u043c\u0438 \u0441\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u043e\u0432',\n # \u041e\u043f\u0446\u0438\u043e\u043d\u0430\u043b\u044c\u043d\u044b\u0435 \u043f\u0430\u0440\u0430\u043c\u0435\u0442\u0440\u044b (include, exclude):\n 'include': <Iterable \u043e\u0431\u044a\u0435\u043a\u0442 \u0441\u043e\u0441\u0442\u043e\u044f\u0449\u0438\u0439 \u0438\u0437 \u043f\u043e\u043b\u0435\u0439 \u043f\u0430\u0441\u043f\u043e\u0440\u0442\u0430 (str) \u043a\u043e\u0442\u043e\u0440\u044b\u0435 \u043d\u0435\u043e\u0431\u0445\u043e\u0434\u0438\u043c\u043e \u043e\u0441\u0442\u0430\u0432\u0438\u0442\u044c \u0432 \u043e\u0431\u044a\u0435\u043a\u0442\u0435 \u043f\u0430\u0441\u043f\u043e\u0440\u0442\u0430>,\n 'exclude': <Iterable \u043e\u0431\u044a\u0435\u043a\u0442 \u0441\u043e\u0441\u0442\u043e\u044f\u0449\u0438\u0439 \u0438\u0437 \u043f\u043e\u043b\u0435\u0439 \u043f\u0430\u0441\u043f\u043e\u0440\u0442\u0430 (str) \u043a\u043e\u0442\u043e\u0440\u044b\u0435 \u043d\u0435\u043e\u0431\u0445\u043e\u0434\u0438\u043c\u043e \u0438\u0441\u043a\u043b\u044e\u0447\u0438\u0442\u044c \u0438\u0437 \u043e\u0431\u044a\u0435\u043a\u0442\u0430 \u043f\u0430\u0441\u043f\u043e\u0440\u0442\u0430>,\n }\n DICT_INTERNAL_PK = 'your pk field name *not alias*'\n PASSPORTS_REL = 'your fieldname for ForeignKey to PARENT_DICT_CLS'\n PARENT_DICT_CLS = 'your base cls modelname for dicts'\n NSI_DICTIONARIES = {\n '\u041b\u043e\u043a\u0430\u043b\u044c\u043d\u043e\u0435 \u043d\u0430\u0437\u0432\u0430\u043d\u0438\u0435 \u0444\u0430\u0439\u043b\u0430 \u0441\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u0430 1': {\n 'model': '\u041f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435.\u041c\u043e\u0434\u0435\u043b\u044c\u0421\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u04301',\n 'oid': 'OID \u0421\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u0430 1',\n # \u041e\u043f\u0446\u0438\u043e\u043d\u0430\u043b\u044c\u043d\u044b\u0435 \u043f\u0430\u0440\u0430\u043c\u0435\u0442\u0440\u044b (filter, include, exclude \u0438 create_sql):\n 'filter': <Callable \u043e\u0431\u044a\u0435\u043a\u0442 \u043f\u0440\u0438\u043d\u0438\u043c\u0430\u0435\u0442 \u0441\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a (dict) \u0434\u043e\u043b\u0436\u0435\u043d \u0432\u0435\u0440\u043d\u0443\u0442\u044c (bool) \u043e\u0441\u0442\u0430\u0432\u043b\u044f\u0442\u044c \u043b\u0438 \u044d\u0442\u043e\u0442 \u043e\u0431\u044a\u0435\u043a\u0442 \u0432 \u0441\u043f\u0438\u0441\u043a\u0435>,\n 'include': <Iterable \u043e\u0431\u044a\u0435\u043a\u0442 \u0441\u043e\u0441\u0442\u043e\u044f\u0449\u0438\u0439 \u0438\u0437 \u043f\u043e\u043b\u0435\u0439 \u0441\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u0430 (str) \u043a\u043e\u0442\u043e\u0440\u044b\u0435 \u043d\u0435\u043e\u0431\u0445\u043e\u0434\u0438\u043c\u043e \u043e\u0441\u0442\u0430\u0432\u0438\u0442\u044c \u0432 \u043e\u0431\u044a\u0435\u043a\u0442\u0435 \u0441\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u0430>,\n 'exclude': <Iterable \u043e\u0431\u044a\u0435\u043a\u0442 \u0441\u043e\u0441\u0442\u043e\u044f\u0449\u0438\u0439 \u0438\u0437 \u043f\u043e\u043b\u0435\u0439 \u0441\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u0430 (str) \u043a\u043e\u0442\u043e\u0440\u044b\u0435 \u043d\u0435\u043e\u0431\u0445\u043e\u0434\u0438\u043c\u043e \u0438\u0441\u043a\u043b\u044e\u0447\u0438\u0442\u044c \u0438\u0437 \u043e\u0431\u044a\u0435\u043a\u0442\u0430 \u0441\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u0430>,\n 'create_sql': <Boolean \u043e\u0431\u044a\u0435\u043a\u0442 (bool), \u0435\u0441\u043b\u0438 True \u0431\u0443\u0434\u0435\u0442 \u0441\u043e\u0437\u0434\u0430\u043d \u0434\u0443\u0431\u043b\u0438\u0440\u0443\u044e\u0449\u0438\u0439 \u0444\u0430\u0439\u043b \u0441\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u0430 \u0432 SQL \u0444\u043e\u0440\u043c\u0430\u0442\u0435>,\n },\n '\u041b\u043e\u043a\u0430\u043b\u044c\u043d\u043e\u0435 \u043d\u0430\u0437\u0432\u0430\u043d\u0438\u0435 \u0444\u0430\u0439\u043b\u0430 \u0441\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u0430 2': {\n 'model': '\u041f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435.\u041c\u043e\u0434\u0435\u043b\u044c\u0421\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u04302',\n 'oid': 'OID \u0421\u043f\u0440\u0430\u0432\u043e\u0447\u043d\u0438\u043a\u0430 2',\n },\n }\n ```\n\n\n## About command\n\u041f\u043e\u0434\u0440\u043e\u0431\u043d\u043e\u0441\u0442\u0438 \u043f\u0440\u043e \u043a\u0430\u0436\u0434\u0443\u044e \u043e\u043f\u0446\u0438\u044e \u043a\u043e\u043c\u0430\u043d\u0434\u044b \u043c\u043e\u0436\u043d\u043e \u0443\u0437\u043d\u0430\u0442\u044c \u0432\u044b\u0437\u0432\u0430\u0432 \u043a\u043e\u043c\u0430\u043d\u0434\u0443 \u0441 \u0444\u043b\u0430\u0433\u043e\u043c `--help`\n\n\n## Contributing\nWe would love you to contribute to `loadnsi`, pull requests are very welcome! Please see [CONTRIBUTING.md](https://github.com/Friskes/loadnsi/blob/main/CONTRIBUTING.md) for more information.\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Friskes\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Utility for downloading and updating NSI fixtures",
"version": "0.1.1",
"project_urls": {
"Changelog": "https://github.com/Friskes/loadnsi/releases/",
"Homepage": "https://github.com/Friskes/loadnsi",
"Issues": "https://github.com/Friskes/loadnsi/issues"
},
"split_keywords": [
"django",
" fixture",
" nsi"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0cf1f0775686748158e13ddc79ae26fee97659630a3fc33cd134f7ff5143855f",
"md5": "ccd94037ae61bba016618342effb48f9",
"sha256": "33f5e72e53668ccfc222439d97196c4dd51e297ac0c5b2453d37a245659a13b5"
},
"downloads": -1,
"filename": "loadnsi-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ccd94037ae61bba016618342effb48f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 32514,
"upload_time": "2025-02-07T20:18:27",
"upload_time_iso_8601": "2025-02-07T20:18:27.172412Z",
"url": "https://files.pythonhosted.org/packages/0c/f1/f0775686748158e13ddc79ae26fee97659630a3fc33cd134f7ff5143855f/loadnsi-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "49626297d84b13556c9f9ee6bb93dc3fae14aa4ae9379897c19c05a3a2f07d5a",
"md5": "e6795f13b91546602180a6b6bc006f52",
"sha256": "e3c74a7eceb4dc989ddd5a1a37739d5ca27afc991dea72605d79da92a2b3706d"
},
"downloads": -1,
"filename": "loadnsi-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "e6795f13b91546602180a6b6bc006f52",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 39277,
"upload_time": "2025-02-07T20:18:29",
"upload_time_iso_8601": "2025-02-07T20:18:29.269465Z",
"url": "https://files.pythonhosted.org/packages/49/62/6297d84b13556c9f9ee6bb93dc3fae14aa4ae9379897c19c05a3a2f07d5a/loadnsi-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-07 20:18:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Friskes",
"github_project": "loadnsi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "loadnsi"
}
