gitea-gitlab-exporter/README.md

60 lines
1.9 KiB
Markdown

# GitLab2Gitea Exporter
A command line tool for copying a project from GitLab to Gitea
## Install
### Development
`pip install --editable .[dev,test]`
## Check that tests work
`pytest`
Should produce something like:
```
===================================================================================== test session starts =====================================================================================
platform linux -- Python 3.11.5, pytest-7.4.2, pluggy-1.3.0 -- /home/ncox/Projects/python-skeleton/venv/bin/python
cachedir: .pytest_cache
rootdir: /home/ncox/Projects/gitea-gitlab-exporter
configfile: pyproject.toml
testpaths: tests
plugins: cov-4.1.0
collected 1 item
tests/test_exporter.py::test_hello_word PASSED [100%]
---------- coverage: platform linux, python 3.11.5-final-0 -----------
Name Stmts Miss Cover Missing
---------------------------------------------------------------------
src/gitea_gitlab_exporter/__init__.py 6 1 83% 18
---------------------------------------------------------------------
TOTAL 6 1 83%
====================================================================================== 1 passed in 0.04s ======================================================================================
```
## Install pre-commit hooks:
`pre-commit install`
Should produce:
`pre-commit installed at .git/hooks/pre-commit`
## Commit files (feel free to make some changes first)
```
git add .
git commit -m ":tada: Initial commit"
```
I like using [gitmoji](https://gitmoji.dev), but that's entirely up to you.
## Note there is a docs directory, but it's really a skeleton and probably doesn't work.
I'll fix this in a later version.