Tool for synchronizing issues between different services
Project description
Issx
Documentation | Source Code | PyPI
Tool for synchronizing issues between different services (e.g. GitHub, Gitlab Jira, etc.)
Disclaimer
Please note that issx
is currently in the early stages of development. As such,
it may be subject to significant changes and improvements.
The links to PyPI and documentation provided above are placeholders and may not be operational yet.
Users are encouraged to consult the GitHub repository for the latest updates and information on this project.
We appreciate your interest and patience as we work to enhance issx
.
Installation
Using pip
pip install issx
Using pipx
pipx install issx
Usage
The basic functionality of issx
is provided through the issx
command-line interface (CLI).
Currently, there is only one command available: copy
.
It allows to copy issues from one place to another. As for now, it supports copying issues between projects in the same backend (Gitlab).
issx copy --source-project-id=<id> --target-project-id=<id> <issue-id>
where source-project-id
and target-project-id
are the IDs of the projects in the same backend and
issue-id
is the ID of the issue to be copied.
Authentication
Gitlab
For the Gitlab backend we use the python-gitlab
package with file-based configuration.
issx
will use the configured default section from the configuration file located in ~/.python-gitlab.cfg
(private_instance
in the example below).
[global]
default = private_instance
[private_instance]
url = https://private-gitlab.com/
private_token = <your_private_token>
To validate the authentication, you can use command:
issx auth-verify
Development
- Clone this repository
- Requirements:
- Poetry
- Python 3.11+
- Create a virtual environment and install the dependencies
poetry install
- Activate the virtual environment
poetry shell
Testing
pytest
Documentation
The documentation is automatically generated from the content of the docs directory and from the docstrings of the public signatures of the source code. The documentation is updated and published as a Github project page automatically as part each release.
Releasing
Trigger the Draft release workflow (press Run workflow). This will update the changelog & version and create a GitHub release which is in Draft state.
Find the draft release from the GitHub releases and publish it. When a release is published, it'll trigger release workflow which creates PyPI release and deploys updated documentation.
Pre-commit
Pre-commit hooks run all the auto-formatters (e.g. ruff
), linters (e.g. mypy
), and other quality
checks to make sure the changeset is in good shape before a commit/push happens.
You can install the hooks with (runs for each commit):
pre-commit install
Or if you want them to run only for each push:
pre-commit install -t pre-push
Or if you want e.g. want to run all checks manually for all files:
pre-commit run --all-files
This project was generated using the nekeal-python-package-cookiecutter template.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.