<div align="center">
<img src="https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-core.svg" height="196" alt="A hexagonal logo of the viur-core" title="viur-core">
<h1>viur-core</h1>
<a href="https://github.com/viur-framework/viur-core/actions/workflows/python-test.yaml">
<img src="https://github.com/viur-framework/viur-core/actions/workflows/python-test.yaml/badge.svg" alt="Badge for Python test suite" title="Python test suite">
</a>
<a href="https://core.docs.viur.dev/en/main/">
<img src="https://readthedocs.org/projects/viur-core/badge/?version=main" alt="Badge for readthedocs.org build status" title="readthedocs.org/viur-core">
</a>
<a href="https://pypi.org/project/viur-core/">
<img alt="Badge showing current PyPI version" title="PyPI" src="https://img.shields.io/pypi/v/viur-core">
</a>
<a href="https://opensource.org/licenses/LGPL-3.0">
<img src="https://img.shields.io/pypi/l/viur-core" alt="Badge displaying the license" title="License badge">
</a>
<br>
This is the core library component of the <a href="https://www.viur.dev">ViUR framework</a>.
</div>
## About
ViUR is an application development toolkit for the Google App Engine™.
ViUR is an open source software development framework that was created to fulfill both designers and developers needs and requirements. It provides a clear concept for implementing agile data management software. It's written in Python™ and already attracted a steady growing community constantly helping and improving ViUR.
## Getting started
To get started with ViUR, check out [viur-base](https://github.com/viur-framework/viur-base). It comes with a pre-configured and well documented project template to immediately start with.
## Migration
### from `<=v3.5` to `v3.6`
In [#833](https://github.com/viur-framework/viur-core/pull/833) the config has
changed from a dict to an object.
To migrate the access expressions like `conf["option"]` in your project
to `conf.option` the viur-core provides a migration script.
Install the _viur-core_ in your project, open a (virtual) environment shell
and `viur-core-migrate-config` will be available.
After checking the result with `viur-core-migrate-config ./deploy/ -d`
you can apply the changes with `viur-core-migrate-config ./deploy/ -x`.
## Contributing
Help of any kind to extend and improve or enhance this project in any kind or way is always appreciated.
We take great interest in your opinion about ViUR. We appreciate your feedback and are looking forward to hear about your ideas. Share your vision or questions with us and participate in ongoing discussions.
See our [contribution guidelines](CONTRIBUTING.md) for details.
## License
Copyright © 2024 by Mausbrand Informationssysteme GmbH.<br>
Mausbrand and ViUR are registered trademarks of Mausbrand Informationssysteme GmbH.
You may use, modify and distribute this software under the terms and conditions of the GNU Lesser General Public License (LGPL). See the file LICENSE provided within this package for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/viur-framework/viur-core",
"name": "viur-core",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Mausbrand Informationssysteme GmbH",
"author_email": "devs@viur.dev",
"download_url": null,
"platform": null,
"description": "<div align=\"center\">\n <img src=\"https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-core.svg\" height=\"196\" alt=\"A hexagonal logo of the viur-core\" title=\"viur-core\">\n <h1>viur-core</h1>\n <a href=\"https://github.com/viur-framework/viur-core/actions/workflows/python-test.yaml\">\n <img src=\"https://github.com/viur-framework/viur-core/actions/workflows/python-test.yaml/badge.svg\" alt=\"Badge for Python test suite\" title=\"Python test suite\">\n </a>\n <a href=\"https://core.docs.viur.dev/en/main/\">\n <img src=\"https://readthedocs.org/projects/viur-core/badge/?version=main\" alt=\"Badge for readthedocs.org build status\" title=\"readthedocs.org/viur-core\">\n </a>\n <a href=\"https://pypi.org/project/viur-core/\">\n <img alt=\"Badge showing current PyPI version\" title=\"PyPI\" src=\"https://img.shields.io/pypi/v/viur-core\">\n </a>\n <a href=\"https://opensource.org/licenses/LGPL-3.0\">\n <img src=\"https://img.shields.io/pypi/l/viur-core\" alt=\"Badge displaying the license\" title=\"License badge\">\n </a>\n <br>\n This is the core library component of the <a href=\"https://www.viur.dev\">ViUR framework</a>.\n</div>\n\n## About\n\nViUR is an application development toolkit for the Google App Engine\u2122.\n\nViUR is an open source software development framework that was created to fulfill both designers and developers needs and requirements. It provides a clear concept for implementing agile data management software. It's written in Python\u2122 and already attracted a steady growing community constantly helping and improving ViUR.\n\n## Getting started\n\nTo get started with ViUR, check out [viur-base](https://github.com/viur-framework/viur-base). It comes with a pre-configured and well documented project template to immediately start with.\n\n## Migration\n\n### from `<=v3.5` to `v3.6`\nIn [#833](https://github.com/viur-framework/viur-core/pull/833) the config has\nchanged from a dict to an object.\nTo migrate the access expressions like `conf[\"option\"]` in your project\nto `conf.option` the viur-core provides a migration script.\nInstall the _viur-core_ in your project, open a (virtual) environment shell\nand `viur-core-migrate-config` will be available.\nAfter checking the result with `viur-core-migrate-config ./deploy/ -d`\nyou can apply the changes with `viur-core-migrate-config ./deploy/ -x`.\n\n## Contributing\n\nHelp of any kind to extend and improve or enhance this project in any kind or way is always appreciated.\n\nWe take great interest in your opinion about ViUR. We appreciate your feedback and are looking forward to hear about your ideas. Share your vision or questions with us and participate in ongoing discussions.\n\nSee our [contribution guidelines](CONTRIBUTING.md) for details.\n\n## License\n\nCopyright \u00a9 2024 by Mausbrand Informationssysteme GmbH.<br>\nMausbrand and ViUR are registered trademarks of Mausbrand Informationssysteme GmbH.\n\nYou may use, modify and distribute this software under the terms and conditions of the GNU Lesser General Public License (LGPL). See the file LICENSE provided within this package for more information.\n",
"bugtrack_url": null,
"license": null,
"summary": "The core component of ViUR, a development framework for Google App Engine",
"version": "3.6.3",
"project_urls": {
"Homepage": "https://github.com/viur-framework/viur-core"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4879012345b61237da73b41726adaf63f7f5eefa091b478c6059b8b8ff84075",
"md5": "bfe2d6b80b8fa23198f10f6f2bf4417a",
"sha256": "03d199ac08f5fec5805f8897f0573b6ecc7e4b91f196088ac06163845e660b51"
},
"downloads": -1,
"filename": "viur_core-3.6.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bfe2d6b80b8fa23198f10f6f2bf4417a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 323740,
"upload_time": "2024-04-09T19:13:54",
"upload_time_iso_8601": "2024-04-09T19:13:54.892954Z",
"url": "https://files.pythonhosted.org/packages/f4/87/9012345b61237da73b41726adaf63f7f5eefa091b478c6059b8b8ff84075/viur_core-3.6.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 19:13:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "viur-framework",
"github_project": "viur-core",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "viur-core"
}
JSON
