#296 shortening description #488 related

nicolay-r · Nov 7, 2023 · 8d0e95e · 8d0e95e
1 parent 5ab8697
commit 8d0e95e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/setup.py b/setup.py
@@ -1,5 +1,3 @@
-from pathlib import Path
-
 from setuptools import (
     setup,
     find_packages,
@@ -15,16 +13,13 @@ def get_requirements(filenames):
     return r_total
 
 
-this_directory = Path(__file__).parent
-long_description = (this_directory / "README.md").read_text()
-
 setup(
     name='arekit',
     version='0.24.0',
     python_requires=">=3.6",
     description='Document level Attitude and Relation Extraction toolkit (AREkit)'
                 ' for sampling and prompting mass-media news into datasets for ML-model training',
-    long_description=long_description,
+    long_description=open('README.md').read(),
     long_description_content_type='text/markdown',
     url='https://github.com/nicolay-r/AREkit',
     author='Nicolay Rusnachenko',

diff --git a/tests/README.md b/tests/README.md
@@ -15,3 +15,12 @@ Using `pytest` to run all the test and gather report into `pytest_report.html` d
 ```bash
 python -m pytest --html=pytest_report.html --self-contained-html --continue-on-collection-errors .
 ```
+
+## Publishing Release
+
+Navigate to the root folder of this project and execute:
+```python
+python3 setup sdist bdist_wheel
+twine check ./dist/*
+twine upload ./dist/*
+```