Commit the changes on your release branch and push them:
bash
git add gliner
git commit -m "Release: v{VERSION}"
git push -u origin main
Step 2: (Optional) Make sure all tests pass
If you add tests, then you should also add CI, e.g. like this [`tests.yaml`](https://github.com/tomaarsen/SpanMarkerNER/blob/main/.github/workflows/tests.yaml) file. This will automatically run tests whenever you make changes, it can be very useful. Make sure all tests that you may have pass before proceeding to the next step.
Step 3: Add a tag for your release
A tag will flag the exact commit associated to your release (and be easier to remember than the commit hash!). The tag should be `v<VERSION>` so for instance `v4.12.0`.
Here is how you can create and push your tag:
bash
git tag v<VERSION>
git push --tags origin main
Step 4: (Optional) Prepare the release notes
You can then put your release notes in a Draft Release on GitHub, in [https://github.com/urchade/GLiNER/releases](https://github.com/urchade/GLiNER/releases) and write a small paragraph highlighting each of the new features this release is adding.
You can use the previously created tag to let GitHub auto-generate some release notes based on recent pull requests.
Step 5: Create the wheels for your release
This is what you'll upload on PyPI and what everyone will download each time they `pip install` your package.
Clean previous builds by deleting the `build` and `dist` directories or by running:
rm -rf build && rm -rf dist
Then run:
bash
python -m build
This will create two folders, `build` and a `dist` with the new versions of your package. These contain a 1) source distribution and a 2) wheel.
Step 6: Upload your package on PyPI test
**DO NOT SKIP THIS STEP!**
This is the most important check before actually releasing your package in the wild. Upload the package on PyPI test and check you can properly install it.
To upload it:
bash
twine upload dist/* -r pypitest --repository-url=https://test.pypi.org/legacy/
You will be prompted for your username and password. If that doesn't work, you can create an API Token for your Test PyPI account and create a `~/.pypirc` account if it doesn't already exist, with:
[distutils]
index-servers =
gliner_test
[gliner_test]
repository = https://test.pypi.org/legacy/
username = __token__
password = pypi-...
(some more details on this [here](https://pypi.org/help/#apitoken))
And then run:
bash
twine upload dist/* -r gliner_test
Once that has uploaded the package, in a fresh environment containing all dependencies you need (tip: you can use Google Colab for this!), try to install your new package from the PyPI test server. First install all dependencies, and then your package.
bash
python -m pip install torch transformers huggingface_hub flair seqeval tqdm
python -m pip install -i https://testpypi.python.org/pypi gliner
If everything works, you should be able to run this code:
python
from gliner import GLiNER
model = GLiNER.from_pretrained("urchade/gliner_base")
text = """
Cristiano Ronaldo dos Santos Aveiro (Portuguese pronunciation: [kɾiʃˈtjɐnu ʁɔˈnaldu]; born 5 February 1985) is a Portuguese professional footballer who plays as a forward for and captains both Saudi Pro League club Al Nassr and the Portugal national team. Widely regarded as one of the greatest players of all time, Ronaldo has won five Ballon d'Or awards,[note 3] a record three UEFA Men's Player of the Year Awards, and four European Golden Shoes, the most by a European player. He has won 33 trophies in his career, including seven league titles, five UEFA Champions Leagues, the UEFA European Championship and the UEFA Nations League. Ronaldo holds the records for most appearances (183), goals (140) and assists (42) in the Champions League, goals in the European Championship (14), international goals (128) and international appearances (205). He is one of the few players to have made over 1,200 professional career appearances, the most by an outfield player, and has scored over 850 official senior career goals for club and country, making him the top goalscorer of all time.
"""
labels = ["person", "award", "date", "competitions", "teams"]
entities = model.predict_entities(text, labels, threshold=0.5)
for entity in entities:
print(entity["text"], "=>", entity["label"])
Step 7: Publish on PyPI
This cannot be undone if you messed up, so make sure you have run Step 6!
Once you’re fully ready, upload your package on PyPI:
bash
twine upload dist/* -r pypi
You will be prompted for your username and password, unless you're using the recommended [PyPI API token](https://pypi.org/help/#apitoken).
Step 8: (Optional) Publish your release notes
Go back to the draft you did at step 4 ([https://github.com/urchade/GLiNER/releases](https://github.com/urchade/GLiNER/releases)) and publish them.
Step 9: Bump the dev version on the main branch
You’re almost done! Just go back to the `main` branch and change the dev version in [`gliner/__init__.py`](gliner/__init__.py) to the new version you’re developing, for instance `4.13.0.dev` if just released `4.12.0`.