refactoring: project directory structure changed, added setup.py file for packaging

Author: unsektor

changelog.md

@@ -5,11 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## 0.1.0 — 2025-02-15
 ### Added
 
 - [x] added `changelog`, `license` files
 
+### Changed
+
+- [x] refactoring: project directory structure changed, added `setup.py` file for packaging
+
 ## Unversioned — 2015-11-17
 
 Initial release

readme.md

@@ -14,22 +14,33 @@ or [Russian](https://ru.wikipedia.org/wiki/Ёфикатор).
 
 ## Usage
 
-Depends on yoficator.dic, which is used for the lookup and should remain in the same folder.
-
-`yoficator.py [text-file-in-Russian | string-in-Russian]`
+1. Build wheel:
+   ```sh
+   python setup.py bdist_wheel -d '/tmp'
+   ```
+2. Install wheel:
+   ```sh
+   pip install yoficator-0.1.0-py2-none-any.whl
+   ```
+3. Use:
+   ```sh
+   python -m yoficator  # [text-file-in-Russian | string-in-Russian]
+   ```
 
 ## Examples
 
 Running the command without arguments parses the test file:
 
-`yoficator.py`
+```sh
+python -m yoficator
+```
 
 Or just use it with a file or string:
 
 ```sh
-yoficator.py russianfile.txt    # prints to STDOUT
-yoficator.py russianfile.txt > russianfile-yoficated.txt
-yoficator.py "Где ее книга?"
+python -m yoficator russianfile.txt    # prints to STDOUT
+python -m yoficator russianfile.txt > russianfile-yoficated.txt
+python -m yoficator "Где ее книга?"
 ```
 
 ## Limitations

setup.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+import setuptools
+
+
+with open('readme.md') as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name='yoficator',
+    version='0.1.0',
+    description='A Russian text yoficator (ёфикатор)',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    license='License :: OSI Approved :: MIT License',
+    packages=['yoficator'],
+    package_data={
+        'yoficator': [
+            '_data/yoficator.dic',
+            '_data/yoficator.txt',
+        ],
+    },
+    install_requires=['regex==2015.11.09'],
+    include_package_data=True,
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=2.7, <3',
+)

yoficator/__init__.py

@@ -68,12 +68,9 @@
 
 pp = pprint.PrettyPrinter(4) 
 
-# Variables initialization; tests a file if no argument is supplied.
-# Save the yoficator as a subfolder of your Desktop
-# TODO: Make it compatible with other OSs.
-workingDir = os.getenv('HOME') + "/Desktop/yoficator/"
-textFile = workingDir + "tests/yoficator.txt"
-dictionaryFile = workingDir + "yoficator.dic"
+workingDir = os.path.abspath(os.path.dirname(__file__)) + '/_data'
+textFile = workingDir + "/yoficator.txt"
+dictionaryFile = workingDir + "/yoficator.dic"
 
 if len(sys.argv) > 1:
     # Is the input a filename?