# gensor
[](https://img.shields.io/github/v/release/zawadzkim/gensor)
[](https://github.com/zawadzkim/gensor/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/zawadzkim/gensor)
[](https://img.shields.io/github/commit-activity/m/zawadzkim/gensor)
[](https://img.shields.io/github/license/zawadzkim/gensor)
Library for handling groundwater sensor data.
- **Github repository**: <https://github.com/zawadzkim/gensor/>
- **Documentation** <https://zawadzkim.github.io/gensor/>
## Getting started with your project
First, create a repository on GitHub with the same name as this project, and then run the following commands:
```bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:zawadzkim/gensor.git
git push -u origin main
```
Finally, install the environment and the pre-commit hooks with
```bash
make install
```
You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
To finalize the set-up for publishing to PyPi or Artifactory, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).
## Releasing a new version
- Create an API Token on [Pypi](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/zawadzkim/gensor/settings/secrets/actions/new).
- Create a [new release](https://github.com/zawadzkim/gensor/releases/new) on Github.
- Create a new tag in the form `*.*.*`.
- For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).
---
Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).
Raw data
{
"_id": null,
"home_page": "https://github.com/zawadzkim/gensor",
"name": "gensor",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Mateusz Zawadzki",
"author_email": "zawadzkimat@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/0d/f4/1038cebfa7bbae086cb2029451ed6f75c9a18d741377dfb2e1da204ce470/gensor-0.2.5.tar.gz",
"platform": null,
"description": "# gensor\n\n[](https://img.shields.io/github/v/release/zawadzkim/gensor)\n[](https://github.com/zawadzkim/gensor/actions/workflows/main.yml?query=branch%3Amain)\n[](https://codecov.io/gh/zawadzkim/gensor)\n[](https://img.shields.io/github/commit-activity/m/zawadzkim/gensor)\n[](https://img.shields.io/github/license/zawadzkim/gensor)\n\nLibrary for handling groundwater sensor data.\n\n- **Github repository**: <https://github.com/zawadzkim/gensor/>\n- **Documentation** <https://zawadzkim.github.io/gensor/>\n\n## Getting started with your project\n\nFirst, create a repository on GitHub with the same name as this project, and then run the following commands:\n\n```bash\ngit init -b main\ngit add .\ngit commit -m \"init commit\"\ngit remote add origin git@github.com:zawadzkim/gensor.git\ngit push -u origin main\n```\n\nFinally, install the environment and the pre-commit hooks with\n\n```bash\nmake install\n```\n\nYou are now ready to start development on your project!\nThe CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.\n\nTo finalize the set-up for publishing to PyPi or Artifactory, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).\nFor activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).\nTo enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).\n\n## Releasing a new version\n\n- Create an API Token on [Pypi](https://pypi.org/).\n- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/zawadzkim/gensor/settings/secrets/actions/new).\n- Create a [new release](https://github.com/zawadzkim/gensor/releases/new) on Github.\n- Create a new tag in the form `*.*.*`.\n- For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).\n\n---\n\nRepository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).\n",
"bugtrack_url": null,
"license": null,
"summary": "Library for handling groundwater sensor data.",
"version": "0.2.5",
"project_urls": {
"Documentation": "https://zawadzkim.github.io/gensor/",
"Homepage": "https://github.com/zawadzkim/gensor",
"Repository": "https://github.com/zawadzkim/gensor"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "18f894371f298b9cedfb9207f12884761864066e5ffb4af312f83404ca116067",
"md5": "2829b3f8147a7e6cc447060afd63d525",
"sha256": "54e3fba6ba62c2db9a40fe1504a04b3a798d776708fac349b5eeb7245ef2c93b"
},
"downloads": -1,
"filename": "gensor-0.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2829b3f8147a7e6cc447060afd63d525",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 320713,
"upload_time": "2024-11-07T18:39:09",
"upload_time_iso_8601": "2024-11-07T18:39:09.863626Z",
"url": "https://files.pythonhosted.org/packages/18/f8/94371f298b9cedfb9207f12884761864066e5ffb4af312f83404ca116067/gensor-0.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0df41038cebfa7bbae086cb2029451ed6f75c9a18d741377dfb2e1da204ce470",
"md5": "7dc7bacc35967df5be6e3959f703a7fd",
"sha256": "23beec8be9c969956307360bcd29fae1bf0639f4e4e29e8beeeedd9722c0cc9c"
},
"downloads": -1,
"filename": "gensor-0.2.5.tar.gz",
"has_sig": false,
"md5_digest": "7dc7bacc35967df5be6e3959f703a7fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 304500,
"upload_time": "2024-11-07T18:39:11",
"upload_time_iso_8601": "2024-11-07T18:39:11.548360Z",
"url": "https://files.pythonhosted.org/packages/0d/f4/1038cebfa7bbae086cb2029451ed6f75c9a18d741377dfb2e1da204ce470/gensor-0.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 18:39:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zawadzkim",
"github_project": "gensor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "gensor"
}
JSON
