python_packaging_example

Пример упаковки Python

Оглавление

• Инструкции с инструкциями
• Фон
• Высокий уровень
• Упаковка Python Projects
  • Создание пакета
  • Загрузка пакета в TestPypi
  • Загрузка пакета в PYPI
  • Обновление пакета вручную
• Действия GitHub CI/CD Workflows
  • Настраивать
  • Загрузка в TestPyPi через Commit to Master
  • Загрузка в PyPi через теги
• Запуск pytest в GitHub CI/CD

---

Инструкции с инструкциями

• Чтобы настроить новые проекты и сделать выпуск, посетите выпуск CI/CD и PYPI

Фон

Это рабочий пример, который использует рабочий процесс действий GitHub CI/CD для тестирования, создания и загрузки пакета Python в TestPYPI и PYPI.

Я создал этот пример пакет, работая через эти руководства;

• Упаковка Python Projects
• Выпуск распределения пакетов публикации с использованием рабочих процессов GitHub CI/CD
• Pytest с действиями GitHub

Остальная часть Readme описывает для создания нового проекта таким же образом.

При настройке;

• Тест и загрузка в TestPypi происходит, когда обновляется номер версии пакета, и в главную филиал внесен коммит
• Тест и загрузка в PYPI происходит, когда коммит помечен
• Пакет может быть установлен с использованием pip install example-package-grumbit

---

Высокий уровень

На высоком уровне процесс настройки упаковки проекта GitHub CI/CD, включая Pytesting, выглядит так;

1. Установите структуру файла в соответствии с этим примером пакета, но оставьте ./.github/workflows/publish-to-test-pypi.yml на данный момент.
2. Получите местную упаковочную работу
3. Получите загрузку в TestPypi Working
4. Загрузите в PYPI работать
5. Добавить ./.github/workflows/publish-to-test-pypi.yml и получить работу Github CI/CD

---

Упаковка Python Projects

Создание пакета

• Метаданные пакета настроены в ./pyproject.toml
• После настройки его можно построить;

 cd < pacakges directory >
python3 -m venv .venv # Create the venv if it doesn't exist yet
source .venv/bin/activate
python3 -m pip install --upgrade pip setuptools wheel pip-tools pytest # Install the tools needed for the build tool
python3 -m pip install --upgrade build # Install the build tool itself
python3 -m build # build the package

Загрузка пакета в TestPypi

• Загрузите пакет для тестирования с помощью;

python3 -m pip install --upgrade twine # Install the twine upload tool
python3 -m twine upload --repository testpypi dist/ * # Upload to TestPyPi
    # When prompted, the username is __token__ and the password is the TestPyPi global scope API token

• Загрузив пакет, токен API, специфичный для пакета, должен быть настроен и сохранен в TestPypi

• Проверьте пакет можно загрузить и использовать в новом venv ;

 cd < some new tmp directory >
python3 -m venv .venv 
source .venv/bin/activate
package_name= " example-package-grumBit "
python3 -m pip install --index-url https://test.pypi.org/simple/ --pre ${package_name}  # Check the package can be installed
python3 -c " from example_package_grumbit import example; print(example.add_one(1)) " # Check package functions

Загрузка пакета в PYPI

python3 -m twine upload dist/ * # Upload to PyPi
    # When prompted, the username is __token__ and the password is the PyPi global scope API token

• Загрузив пакет, токен API, специфичный для пакета, должен быть настроен и сохранен в PYPI

Обновление пакета вручную

• Каждый раз, когда пакет обновляется, его версия должна быть обновлена ​​в разделе [project] .

vs ./pyproject.toml
python3 -m build # build the package
python3 -m twine check dist/ * # check the package can be uploaded
python3 -m twine upload --repository testpypi dist/ * # test uploading using TestPyPi
python3 -m twine upload dist/ * # Upload to PyPi

---

Действия GitHub CI/CD Workflows

Настраивать

• Если проект уже не синхронизируется до GitHub, запустите;

 cd " <the project's directory> "
repo_name= " <the new repo's name> "
gh repo create " ${repo_name} " --private
git init
git add --all
git commit -m " init "
git branch -M master
git remote add origin [email protected]:grumBit/ ${repo_name} .git
git push -u origin master

• Если филиал по умолчанию не является master , либо измените его на GitHub, либо измените .github/workflows/publish-to-test-pypi.yml .

• Добавить токены API TestPypi и PYPI в репо

• Откройте репо на GitHub, используя gh browse . В браузере нажмите Settings -> Secrets -> Actions . Затем добавьте два новых секрета под названием PYPI_API_TOKEN и TEST_PYPI_API_TOKEN , с токенами API, созданным после загрузки пакетов выше

• Создать и настраивать .github/workflows/publish-to-test-pypi.yml определение рабочего процесса

  • NB: publish-to-test-pypi.yml в этом примере.

Загрузка в TestPyPi через Commit to Master

• Каждый раз, когда коммит вступает в master ветвь, GitHub CI/CD будет работать.
  • NB: Для успеха упаковки версия должна быть обновлена ​​в ./pyproject.toml.
• Все коммиты в Master будут загружены в TestPyPi

Загрузка в PyPi через теги

• Поместив тег на коммит и нажатие его приведет к тому, что GitHub CI/CD запускается и создает релиз PYPI.

• Используйте следующее, чтобы отметить самый последний коммит (IE HEAD ) с версией, настроенной в настоящее время в ./pyproject.toml ;

version_tag=v $( cat ./pyproject.toml | egrep " ^version " | cut -d ' " ' -f2 )
version_tag_info= " Some release info "
git tag -a " ${version_tag} " -m " ${version_tag_info} "
git push --tag

• Используйте следующее, чтобы пометить предыдущий коммит;

version_tag= " vX.X.X "
version_tag_info= " Some release info "
commit_sha= " 16fb0fd "
git tag -a " ${version_tag} " " ${commit_sha} " -m " ${version_tag_info} "
git push --tag

---

Запуск pytest в GitHub CI/CD

• Рабочий процесс в руководстве GitHub CI/CD не включал запуск Pytests. Чтобы заставить Pytest запустить зависимости пакетов, необходимые для установки, а затем Pytest запустите перед шагом сборки, используя эти дополнительные шаги;

    - name : Install requirements
      run : >-
        python -m
        pip install
        --requirement requirements.txt
    - name : Run tests
      run : >-
        python -m
        pytest

• Согласно структуре каталогов в Руководстве по проектам упаковки, я поместил тесты в отдельную иерархию источнику. Это означало __init__.py , необходимый для добавления в src/ и tests/ каталог, подобный этому;
  • NB: Я не уверен в этом структуре. Это следует за руководством и означает, что тестовый код не упакован, однако, я думаю, что он менее удобен, чем test/ папки встраивания в src/ дереве. ./pyproject.toml можно настроить так, чтобы встроенные test/ папки были исключены, но на данный момент я пошел с «стандартом».

packaging_tutorial/
├── src/
│   ├── __init__.py
│   └── example_package_grumbit/
│       ├── __init__.py
│       └── example.py
└── tests/
    ├── __init__.py
    └── example_package_grumbit/
        ├── __init__.py
        └── test_example.py