# ToDo Merger
Get an overview of all issues assigned to you on GitHub and one or more GitLab
instances.
Very early stage, contributions and ideas are welcome!
## Installation
### Install and run via pipx (Recommended)
[pipx](https://pypa.github.io/pipx/) makes installing and running Python programs easier and avoid conflicts with other packages. Install it with
```sh
pip3 install pipx
```
The following one-liner both installs and runs this program from [PyPI](https://pypi.org/project/todo-merger/):
```sh
pipx run todo-merger
```
If you want to be able to use todo-merger without prepending it with `pipx run` every time, install it globally like so:
```sh
pipx install todo-merger
```
todo-merger will then be available in `~/.local/bin`, which must be added to your `$PATH`. On Windows, the required path for your environment may look like `%USERPROFILE%\AppData\Roaming\Python\Python310\Scripts`, depending on the Python version you have installed.
To upgrade todo-merger to the newest available version, run this command:
```sh
pipx upgrade todo-merger
```
### Other installation methods
You may also use pure `pip` or `poetry` to install this package.
## Usage
Run `todo-merger`. This will run the application. You can interact with it using your browser on http://localhost:8636.
## Configuration
Upon start, the program will create a new empty configuration file. You will probably run into an error because no login data is present. From the error messages, you can find the config file in which you will have to add your data.
This will surely be improved in the next versions.
## License
The main license of this project is the GNU General Public License 3.0, no later version (`GPL-3.0-only`), Copyright Max Mehl.
There are also parts from third parties under different licenses, e.g. Pico CSS (MIT) and snippets from DB Systel (Apache-2.0). Thank you!
Raw data
{
"_id": null,
"home_page": "https://github.com/mxmehl/todo-merger",
"name": "todo-merger",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Max Mehl",
"author_email": "mail@mehl.mx",
"download_url": "https://files.pythonhosted.org/packages/10/87/0d361da0959ce601f665c15836b90e37ca82f1ccf1547f3e87c90763aece/todo_merger-0.5.4.tar.gz",
"platform": null,
"description": "# ToDo Merger\n\nGet an overview of all issues assigned to you on GitHub and one or more GitLab\ninstances.\n\nVery early stage, contributions and ideas are welcome!\n\n\n## Installation\n\n### Install and run via pipx (Recommended)\n\n[pipx](https://pypa.github.io/pipx/) makes installing and running Python programs easier and avoid conflicts with other packages. Install it with\n\n```sh\npip3 install pipx\n```\n\nThe following one-liner both installs and runs this program from [PyPI](https://pypi.org/project/todo-merger/):\n\n```sh\npipx run todo-merger\n```\n\nIf you want to be able to use todo-merger without prepending it with `pipx run` every time, install it globally like so:\n\n```sh\npipx install todo-merger\n```\n\ntodo-merger will then be available in `~/.local/bin`, which must be added to your `$PATH`. On Windows, the required path for your environment may look like `%USERPROFILE%\\AppData\\Roaming\\Python\\Python310\\Scripts`, depending on the Python version you have installed.\n\nTo upgrade todo-merger to the newest available version, run this command:\n\n```sh\npipx upgrade todo-merger\n```\n\n### Other installation methods\n\nYou may also use pure `pip` or `poetry` to install this package.\n\n\n## Usage\n\nRun `todo-merger`. This will run the application. You can interact with it using your browser on http://localhost:8636.\n\n\n## Configuration\n\nUpon start, the program will create a new empty configuration file. You will probably run into an error because no login data is present. From the error messages, you can find the config file in which you will have to add your data.\n\nThis will surely be improved in the next versions.\n\n\n## License\n\nThe main license of this project is the GNU General Public License 3.0, no later version (`GPL-3.0-only`), Copyright Max Mehl.\n\nThere are also parts from third parties under different licenses, e.g. Pico CSS (MIT) and snippets from DB Systel (Apache-2.0). Thank you!\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "Overview of your assigned issues on GitHub and GitLab",
"version": "0.5.4",
"project_urls": {
"Homepage": "https://github.com/mxmehl/todo-merger",
"Repository": "https://github.com/mxmehl/todo-merger"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "88f7fd3800d25beab577d6b6eb6038fa80c106564792234b14f440f23d095bfa",
"md5": "260c0e4f72021b8d8f24c8cb24015156",
"sha256": "9b9ca252fe8343eec292a385aeb326432141e39f167e32e6592ad76a4e423519"
},
"downloads": -1,
"filename": "todo_merger-0.5.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "260c0e4f72021b8d8f24c8cb24015156",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 752566,
"upload_time": "2024-09-16T13:10:27",
"upload_time_iso_8601": "2024-09-16T13:10:27.756370Z",
"url": "https://files.pythonhosted.org/packages/88/f7/fd3800d25beab577d6b6eb6038fa80c106564792234b14f440f23d095bfa/todo_merger-0.5.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "10870d361da0959ce601f665c15836b90e37ca82f1ccf1547f3e87c90763aece",
"md5": "2f425a30cf44fe897161cae22e410ece",
"sha256": "c5814364f4ad9de2b21fba45c2cba23d0c4cecbc9e6c236a4767772ad235da77"
},
"downloads": -1,
"filename": "todo_merger-0.5.4.tar.gz",
"has_sig": false,
"md5_digest": "2f425a30cf44fe897161cae22e410ece",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 748607,
"upload_time": "2024-09-16T13:10:29",
"upload_time_iso_8601": "2024-09-16T13:10:29.503817Z",
"url": "https://files.pythonhosted.org/packages/10/87/0d361da0959ce601f665c15836b90e37ca82f1ccf1547f3e87c90763aece/todo_merger-0.5.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-16 13:10:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mxmehl",
"github_project": "todo-merger",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "todo-merger"
}
JSON
