| Name | mod-dlm-server JSON |
| Version |
1.0.7
JSON |
| download |
| home_page | None |
| Summary | mod-dlm-server is an open-source REST server for storing and querying element data described using the mod-dlm domain-specific language (DSL). |
| upload_time | 2024-07-29 10:13:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
openapi
mod-dlm
api
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<a href="https://mod.construction/" target="_blank">
<img src="https://raw.githubusercontent.com/mod-construction/mod-dlm-server-fastapi/main/mod-dlm-fastapi-server.png" alt="mod-dlm-logo"/>
</a>
# mod-dlm-fastapi-server
[](https://github.com/mod-construction/mod-dlm/actions/workflows/publish.yml)
[](https://pypi.org/project/mod-dlm-server/)
[](https://opensource.org/licenses/MIT)
</div>
**mod-dlm-server** is an open-source REST server for storing and querying element data described using the **[mod-dlm](https://github.com/mod-construction/mod-dlm)** domain-specific language (DSL).
This project provides tools for defining entity models and automatically generating CRUD APIs, enabling suppliers to create and manage catalogs of their products easily.
You can always find the most up-to-date API documentation here: [mod-dlm API Docs](https://mod-construction.github.io/mod-dlm/)
The server is generated automatically using the [OpenAPI Generator](https://openapi-generator.tech).
- API version: 1.0.7
- Build date: 2024-07-29T09:54:52.280606897Z[Etc/UTC]
- Generator version: 7.8.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonFastAPIServerCodegen
## Requirements.
Python >= 3.7
## Installation & Usage
To run the server, please execute the following from the root directory:
```bash
pip install -r requirements.txt
PYTHONPATH=src uvicorn mod_dlm_server.main:app --host 0.0.0.0 --port 8080
```
and open your browser at `http://localhost:8080/docs/` to see the docs.
## Running with Docker
To run the server on a Docker container, please execute the following from the root directory:
```bash
docker-compose up --build
```
## Tests
To run the tests:
```bash
pip3 install pytest
PYTHONPATH=src pytest tests
```
Raw data
{
"_id": null,
"home_page": null,
"name": "mod-dlm-server",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenAPI mod-dlm API",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1d/7c/2c0b43dcc73ab3275310f29635c73f5687a91415d73e4ef3e970d5b334c4/mod_dlm_server-1.0.7.tar.gz",
"platform": null,
"description": "\n\n<div align=\"center\">\n <a href=\"https://mod.construction/\" target=\"_blank\">\n <img src=\"https://raw.githubusercontent.com/mod-construction/mod-dlm-server-fastapi/main/mod-dlm-fastapi-server.png\" alt=\"mod-dlm-logo\"/>\n </a>\n\n\n\n# mod-dlm-fastapi-server\n\n[](https://github.com/mod-construction/mod-dlm/actions/workflows/publish.yml)\n[](https://pypi.org/project/mod-dlm-server/)\n[](https://opensource.org/licenses/MIT)\n</div>\n\n**mod-dlm-server** is an open-source REST server for storing and querying element data described using the **[mod-dlm](https://github.com/mod-construction/mod-dlm)** domain-specific language (DSL).\nThis project provides tools for defining entity models and automatically generating CRUD APIs, enabling suppliers to create and manage catalogs of their products easily.\n\nYou can always find the most up-to-date API documentation here: [mod-dlm API Docs](https://mod-construction.github.io/mod-dlm/)\n\n\nThe server is generated automatically using the [OpenAPI Generator](https://openapi-generator.tech).\n\n- API version: 1.0.7\n- Build date: 2024-07-29T09:54:52.280606897Z[Etc/UTC]\n- Generator version: 7.8.0-SNAPSHOT\n- Build package: org.openapitools.codegen.languages.PythonFastAPIServerCodegen\n\n## Requirements.\n\nPython >= 3.7\n\n## Installation & Usage\n\nTo run the server, please execute the following from the root directory:\n\n```bash\npip install -r requirements.txt\nPYTHONPATH=src uvicorn mod_dlm_server.main:app --host 0.0.0.0 --port 8080\n```\n\nand open your browser at `http://localhost:8080/docs/` to see the docs.\n\n## Running with Docker\n\nTo run the server on a Docker container, please execute the following from the root directory:\n\n```bash\ndocker-compose up --build\n```\n\n## Tests\n\nTo run the tests:\n\n```bash\npip3 install pytest\nPYTHONPATH=src pytest tests\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "mod-dlm-server is an open-source REST server for storing and querying element data described using the mod-dlm domain-specific language (DSL).",
"version": "1.0.7",
"project_urls": null,
"split_keywords": [
"openapi",
"mod-dlm",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "573e4cdacf3f10b049049df12dbdc317141db7ed6e2477173f3d7997dcfe50f0",
"md5": "0bf8da8d6b7b4008813b74abff3db70e",
"sha256": "2f59a87fdbc23b4d5b4ad3b1141ff44ad490d5d249ecba70e587a899a9fe12f8"
},
"downloads": -1,
"filename": "mod_dlm_server-1.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0bf8da8d6b7b4008813b74abff3db70e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 35260,
"upload_time": "2024-07-29T10:13:04",
"upload_time_iso_8601": "2024-07-29T10:13:04.140449Z",
"url": "https://files.pythonhosted.org/packages/57/3e/4cdacf3f10b049049df12dbdc317141db7ed6e2477173f3d7997dcfe50f0/mod_dlm_server-1.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1d7c2c0b43dcc73ab3275310f29635c73f5687a91415d73e4ef3e970d5b334c4",
"md5": "931a63225140f27f50e772ef0369ab0a",
"sha256": "af85c77d3e43b287770d4ecfffe5d6f8a465b9481dcec4febaeb4cefafac03db"
},
"downloads": -1,
"filename": "mod_dlm_server-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "931a63225140f27f50e772ef0369ab0a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13237,
"upload_time": "2024-07-29T10:13:05",
"upload_time_iso_8601": "2024-07-29T10:13:05.352994Z",
"url": "https://files.pythonhosted.org/packages/1d/7c/2c0b43dcc73ab3275310f29635c73f5687a91415d73e4ef3e970d5b334c4/mod_dlm_server-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-29 10:13:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mod-dlm-server"
}
