| Name | tibian JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | https://github.com/Alicipy/tibian |
| Summary | Ticket birthday announcer: A package to announce all creation birthdays of your tickets that live (too) long enough |
| upload_time | 2024-02-29 21:35:41 |
| maintainer | |
| docs_url | None |
| author | Stefan Kraus |
| requires_python | >=3.9,<4.0 |
| license | MIT |
| keywords |
agile
jira
birthdays
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Tibian
======
Project 'tibian', also known as the 'TIcket Birthday Announcer',
is a project to announce tickets that it's birthday today.
That means it announces ticket titles and summaries that were created a few
years ago and are still open to a number of channels that you specified before.
For example, the Jira tickets of a project can be published to a Teams channel
regularly and make some people happy (or angry).
Right now, the project is in a very early stage and it's not fully functional.
Usage
-----
To use this project, you need to create a configuration file in the same directory.
To start, copy the `config.example.yaml` file to `config.yaml` and edit it.
The name is important here, because it's used to identify the configuration file.
For details about configuration, visit section `Configuration`.
To install the project, run one of the following command::
poetry install # or
pip install tibian
Later one is preferred, as it installs the project with the same versions
as we tested before release and in a virtual environment.
Afterwards, you can start the project by running the `tibian` command::
tibian
Afterwards, it should announce the birthdays of tickets of the current date
as specified.
Configuration
-------------
The configuration file for the project must be located in the root folder
of the execution command. A short (any maybe not complete) description of
the configuration file is given in `config.example.yaml` on GitHub.
Copy this output to a file `config.yaml` in the current directory, add your credentials
and remove parts you don't need.
Detailed information about all config options will be given soon,
but for this version most of the configuration should be self-explanatory.
'type' is the type of source or target you have,
'name' is an internal used name for the source/target, and
'config' is a type-dependant dictionary of types as shown.
Versioning
-----------
We use `semantic versioning`_ to version the project. As we are in some sort of 'beta',
we may (but try not to) do some breaking changes between minor versions to fix some obvious
misbehavior of the project. For example, we may change the configuration file format or
add new options to the configuration file. As we try to prevent this and add a backlog how to
upgrade to newer versions, you maybe want to check the changelog before updating to new versions.
Development
-----------
We are always happy about active support. If you want to actively develop on tibian, follow the next few commands.
We use poetry_ for the development of tibian. You can install it with the following command::
pip install poetry
To install all development dependencies, run::
poetry install --with dev
Afterwards, you have all dependencies (including dev dependencies) installed in a virtualenv, and are able to develop.
To add new dependencies, run::
poetry add <package>
To activate your virtualenv, run::
poetry shell
Afterwards, you can run all following commands in the virtualenv. In case you don't, you have to add 'poetry run' before each
of the next commands to execute it in the virtualenv, or you will get missing requirements errors.
Additionally, we use `pre-commit`_ as our tool to enforce some styling and lint rules. To install pre-commit, run::
pre-commit install
This will install all hooks and run them automatically on a commit. You can also run these rules manually by doing::
pre-commit run --all
To run the tests and get some coverage information, run::
./scripts/run_tests.sh
.. _poetry: https://python-poetry.org/
.. _pre-commit: https://pre-commit.com/
.. _semantic versioning: https://semver.org/
Raw data
{
"_id": null,
"home_page": "https://github.com/Alicipy/tibian",
"name": "tibian",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "agile,jira,birthdays",
"author": "Stefan Kraus",
"author_email": "dev@stefankraus.org",
"download_url": "https://files.pythonhosted.org/packages/bf/7b/bf0fa6560c1e4fc6d349bdfbcb6eceae06fd25665ff67f760bce6282b53a/tibian-1.1.0.tar.gz",
"platform": null,
"description": "Tibian\n======\n\nProject 'tibian', also known as the 'TIcket Birthday Announcer',\nis a project to announce tickets that it's birthday today.\nThat means it announces ticket titles and summaries that were created a few\nyears ago and are still open to a number of channels that you specified before.\nFor example, the Jira tickets of a project can be published to a Teams channel\nregularly and make some people happy (or angry).\n\nRight now, the project is in a very early stage and it's not fully functional.\n\n\nUsage\n-----\n\nTo use this project, you need to create a configuration file in the same directory.\nTo start, copy the `config.example.yaml` file to `config.yaml` and edit it.\nThe name is important here, because it's used to identify the configuration file.\nFor details about configuration, visit section `Configuration`.\n\nTo install the project, run one of the following command::\n\n poetry install # or\n pip install tibian\n\nLater one is preferred, as it installs the project with the same versions\nas we tested before release and in a virtual environment.\n\nAfterwards, you can start the project by running the `tibian` command::\n\n tibian\n\nAfterwards, it should announce the birthdays of tickets of the current date\nas specified.\n\nConfiguration\n-------------\n\nThe configuration file for the project must be located in the root folder\nof the execution command. A short (any maybe not complete) description of\nthe configuration file is given in `config.example.yaml` on GitHub.\n\nCopy this output to a file `config.yaml` in the current directory, add your credentials\nand remove parts you don't need.\n\nDetailed information about all config options will be given soon,\nbut for this version most of the configuration should be self-explanatory.\n\n'type' is the type of source or target you have,\n'name' is an internal used name for the source/target, and\n'config' is a type-dependant dictionary of types as shown.\n\n\nVersioning\n-----------\n\nWe use `semantic versioning`_ to version the project. As we are in some sort of 'beta',\nwe may (but try not to) do some breaking changes between minor versions to fix some obvious\nmisbehavior of the project. For example, we may change the configuration file format or\nadd new options to the configuration file. As we try to prevent this and add a backlog how to\nupgrade to newer versions, you maybe want to check the changelog before updating to new versions.\n\n\nDevelopment\n-----------\n\nWe are always happy about active support. If you want to actively develop on tibian, follow the next few commands.\nWe use poetry_ for the development of tibian. You can install it with the following command::\n\n pip install poetry\n\nTo install all development dependencies, run::\n\n poetry install --with dev\n\nAfterwards, you have all dependencies (including dev dependencies) installed in a virtualenv, and are able to develop.\n\nTo add new dependencies, run::\n\n poetry add <package>\n\nTo activate your virtualenv, run::\n\n poetry shell\n\nAfterwards, you can run all following commands in the virtualenv. In case you don't, you have to add 'poetry run' before each\nof the next commands to execute it in the virtualenv, or you will get missing requirements errors.\n\nAdditionally, we use `pre-commit`_ as our tool to enforce some styling and lint rules. To install pre-commit, run::\n\n pre-commit install\n\nThis will install all hooks and run them automatically on a commit. You can also run these rules manually by doing::\n\n pre-commit run --all\n\nTo run the tests and get some coverage information, run::\n\n ./scripts/run_tests.sh\n\n.. _poetry: https://python-poetry.org/\n.. _pre-commit: https://pre-commit.com/\n.. _semantic versioning: https://semver.org/\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Ticket birthday announcer: A package to announce all creation birthdays of your tickets that live (too) long enough",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/Alicipy/tibian",
"Repository": "https://github.com/Alicipy/tibian"
},
"split_keywords": [
"agile",
"jira",
"birthdays"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1eaf40d871ea2b88fc6842cd62c354d1b60c1c47152bd7519b4dc7a3c352702b",
"md5": "8fe27dfa20a8ed711dfda4cd96ec9444",
"sha256": "9b2f141d94d76136aefeae535fbc45423df17824f056a76a9e99b558bbce25c3"
},
"downloads": -1,
"filename": "tibian-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8fe27dfa20a8ed711dfda4cd96ec9444",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 9238,
"upload_time": "2024-02-29T21:35:39",
"upload_time_iso_8601": "2024-02-29T21:35:39.529029Z",
"url": "https://files.pythonhosted.org/packages/1e/af/40d871ea2b88fc6842cd62c354d1b60c1c47152bd7519b4dc7a3c352702b/tibian-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf7bbf0fa6560c1e4fc6d349bdfbcb6eceae06fd25665ff67f760bce6282b53a",
"md5": "d63767213a15746d675c90e6fc6deaa7",
"sha256": "1fee8d8a989b7a14d97cca27c273574220d0af46c1b210c7439c242b43a46858"
},
"downloads": -1,
"filename": "tibian-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "d63767213a15746d675c90e6fc6deaa7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 7553,
"upload_time": "2024-02-29T21:35:41",
"upload_time_iso_8601": "2024-02-29T21:35:41.468605Z",
"url": "https://files.pythonhosted.org/packages/bf/7b/bf0fa6560c1e4fc6d349bdfbcb6eceae06fd25665ff67f760bce6282b53a/tibian-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-29 21:35:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Alicipy",
"github_project": "tibian",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tibian"
}
