How to publish your repository
Install Poetry: This command installs Poetry, a tool for dependency management and packaging in Python. Configure PyPI Credentials: This step configures your PyPI credentials so that Poetry can authenticate with PyPI. Build the Package: This command builds the source distribution and wheel for your package. Publish the Package: This command publishes your package to PyPI. Make sure your pyproject.toml file is correctly configured, as shown in your provided excerpt. This includes specifying the package name, version, description, authors, dependencies, and build system. After running these commands, your package should be available on PyPI.
▶ Steps
- Register to PyPI.
- Register the PyPI token in Poetry.
- Commit the latest version to the main branch and add a tag.
- Publish.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# Configure PyPI credentials
poetry config pypi-token.pypi <your-pypi-token>
# commit
git commit -m "PUB: v.1.4.0"
# add tag
git tag v1.4.0
# push
git push
# Publish the package
poetry publish --build
▶ Is it okay to add the dist folder to .gitignore, which is created when running the poetry publish --build command?
the poetry publish --build command creates the dist folder. Here’s why:
- Build Process: When you run
poetry publish --build, Poetry first builds your package. This involves creating distribution archives (e.g., source distribution.tar.gzand wheel.whlfiles) for your project. - Output Location: These distribution files are placed in the
distfolder by default. This folder is where Poetry stores the built artifacts before they are uploaded to PyPI.
The dist folder is essentially a temporary storage location for the built package files.
Since these files can be regenerated by running the build command again, it is common practice to add the dist folder to your .gitignore file to avoid cluttering your repository with build artifacts.
(注意：GitHub Accountが必要となります）