path: root/README.md

# lazygl2srht - Gitlab to Sourcehut issue migration tool

Sourcehut project: https://sr.ht/~khumba/lazygl2srht/

This is a program for importing issues from an exported Gitlab project into a
fresh Sourcehut tracker, via SMTP.  I am lazy, so this works well enough for my
simple projects, but certainly doesn't include all data that could be included,
and also requires some manual work on your part for best results.

Documentation is included at the top of `import_issues.py`.  Please read that
before running an import.

## Contributing

Patches, suggestions, etc. are welcome at:
https://lists.sr.ht/~khumba/public-inbox

The Python code here is formatted with [Black](https://pypi.org/project/black/).
Please add the following to your Git pre-commit hook, to verify that the file is
properly formatted before committing.  Create `.git/hooks/pre-commit` with the
following contents, and mark the file as executable with `chmod +x`:

    #!/bin/sh

    black --check import_issues.py

Please also run the following command on your local copy of the repository, so
that patches are clearly labelled on the list; see `git-format-patch(1)` for
more info:

    git config format.subjectPrefix "PATCH lazygl2shrt"

## License

Copyright 2024 Bryan Gardiner <bog@khumba.net>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.