Я очень рад объявить First Release readmegenie! ? Этот проект был невероятно полезен, увидев, что он ожил на PYPI. С версией 1.0.0 , ReadMegenie теперь доступен для разработчиков везде, чтобы сгенерировать чистые, краткие и профессиональные файлы readme.md для своих проектов без усилий.

---

]

] что такое readmegenie? ]

]

readmegenie-это инструмент CLI на основе Python, предназначенный для упрощения создания файлов readme.md. Автоматизируя утомительный процесс написания подробной документации, ReadMegenie помогает разработчикам больше внимания уделять кодированию и меньше на форматировании.

]

с readmegenie , вы можете:

]
• генерировать структурированные файлы readme.md с помощью разделов, например installation , usage , и ancome .
включите интеграцию API, чтобы адаптировать ваш Readme на основе типа проекта.
быстро обновите свои файлы readme по мере развития вашего проекта.
• ]
]

Readmegenie-это изменение игры для разработчиков, работающих над проектами с открытым исходным кодом или совместными хранилищами. Если вы хотите попробовать, вы можете установить его со следующей командой:

]
]

pip install -i https://test.pypi.org/simple/ readmegenie == 1.0.0

pip install -i https://test.pypi.org/simple/ ReadmeGenie==1.0.0

проверьте репозиторий GitHub, чтобы узнать больше, изучить кодовую базу или внести свой вклад в проект.

]

]

---

]

автоматизация выпусков с помощью GitHub Actions ] ]

Одним из основных моментов путешествия ReadMegenie является то, как мы автоматизировали его процесс развертывания в PYPI, используя

github actions . Каждый раз, когда новая тег версии выдвигается в репозиторий, наш трубопровод автоматизации создает пакет, запускает тесты и публикует его в PYPI. Вот как мы достигли этого: ]

]

1. Управление версией с тегами GIT ] ]

мы интегрировали setuptools_scm, чтобы получить версию проекта непосредственно из тегов GIT. Это гарантирует, что каждый релиз версирован правильно без необходимости ручных обновлений в файле pyproject.toml. Помежавая релиз (например, V1.0.0), трубопровод автоматически устанавливает версию динамически.

]

]

2. Автоматизированные рабочие процессы с GitHub Actions ] ]

наш рабочий процесс действий GitHub включает в себя следующие шаги:

]

]

]

1. тестирование и лининг: ]

   ]
   каждый push -tergers тестирует с использованием pytest и кодового сжима Flake8.
   это гарантирует, что проект остается надежным и придерживается лучших практик Python.
   ]
   ]
]

2. Создание пакета:

   ]
   трубопровод строит файлы распределения (SDIST и колеса) с использованием Setuptools.
   • ]
   ]
   ]
]

3. публикация в pypi:

   ]
   с помощью Twine, встроенные пакеты загружаются в PYPI или TESTPYPI, в зависимости от окружающей среды.
   • ]
   ]
   ]
]

вот фрагмент из наших действий Github Workflow:

]
]

name: publish to pypi на: толкать: Теги: - 'v*' # Trigger Workflow для тегов версий Работа: Сборка и публикация: Runs-on: Ubuntu-Latest Шаги: - Использует: Действия/Осмотр@v4 - Имя: настроить Python Использование: Action/Setup-Python@v3 с: Python-версия: "3.12" - Имя: установить зависимости запустить: | Python3 -m Pip Install -обновление PIP Build Setuptools_scm Twine - Название: сборка сборки запустить: python3 -m Build - Имя: опубликовать пакет в PYPI env: Twine_username: __token__ Twine_password: $ {{secrets.pypi_api_token}} запустить: python3 -m watine upload dist/*

pip install -i https://test.pypi.org/simple/ ReadmeGenie==1.0.0

]

3. Управление секретами ] ]

для обеспечения безопасности токен PYPI API хранится как

github secret (pypi_api_token) и вводится в рабочий процесс во время выполнения. Это устраняет необходимость раскрытия конфиденциальной информации в кодовой базе. ]

]

---

]

что дальше для ReadMegenie? ] ]

это только начало! ? Для будущих выпусков мы планируем:

]

]

добавить поддержку для более настраиваемых шаблонов.
• ]
интегрируйте расширенные инструменты NLP для генерации контекстных разделов чтения.
• ]
приспособлен больше инструментов Genai, кроме Groq и Cohere.
• ]
]

мы также с нетерпением ждем сотрудничества с сообществом, чтобы сделать Readmegenie еще лучше. Не стесняйтесь вносить свой вклад или сообщать о проблемах в нашем репозитории GitHub.

]

]

---

]

последнее слово ] ]

Путешествие по развертыванию ReadMegenie не было без проблем, но автоматизация процесса выпуска с помощью GitHub Dains изменил игру. Это гарантирует, что каждый релиз является плавным, последовательным и надежным.

]

Если вы разработчик, который находит писать документацию утомительной или повторяющейся, дайте Readmegenie попробовать. Мы не можем дождаться, чтобы увидеть удивительные проекты, которые вы создадите с ним!

счастливого кодирования! ?

]

] ]