Repository: measles/latynkatar (language: python)

Issue:
Запакетаваць
Стварыць належным чынам пакет і выкласці яго на PyPI


Discussion / hints:

Fix patch:
diff --git a/.gitignore b/.gitignore
index 753c5f2..546819c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,8 @@
 __pycache__
+.pytest_cache
+test-venv
+build-env
+dist
 venv
 .idea
 ~*
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..0a04128
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
diff --git a/Makefile b/Makefile
index 2c8d7e6..a0b9bd3 100644
--- a/Makefile
+++ b/Makefile
@@ -5,4 +5,24 @@ test:
 	python3 -m pytest tests -lvv -ra
 	
 black:
-	python3 -m black --check tests/ latynkatar.py || python3 -m black --diff tests/ latynkatar.py
+	python3 -m black --check tests/ src/
+
+black_diff:
+	python3 -m black --diff tests/ src/
+
+blacked:
+	python3 -m black tests/ src/
+
+build_env:
+	python3 -m venv build-env
+
+build:
+	python3 -m pip install -r build-requirements.txt
+	python3 -m build
+
+upload:
+	python3 -m twine upload dist/*
+
+clean:
+	rm -rf test-venv 
+	rm -rf build-env
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e67adf0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
+
+# Latynkatar
+
+Маленькая і простая бібліятэка для канвертацыі кірыліцы ў сучасную (з č, š, ǔ) лацінку.
\ No newline at end of file
diff --git a/build-requirements.txt b/build-requirements.txt
new file mode 100644
index 0000000..51e16c7
--- /dev/null
+++ b/build-requirements.txt
@@ -0,0 +1,2 @@
+build
+twine
\ No newline at end of file
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..02e7f14
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,24 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "latynkatar"
+version = "0.1"
+authors = [
+  { name="Andrej Zacharevicz", email="zahar.by@gmail.com" },
+]
+description = """EN: Simple and small package to convert belarussian cyrillic text to a  modern latin (the one with č, š and ǔ).
+
+BE: Просты і невялікі пакет для канвертацыі беларускай кірыліцы ў сучасную лацінку (з č, š і ǔ)."""
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/measles/latynkatar"
+Issues = "https://github.com/measles/latynkatar/issues"
\ No newline at end of file
diff --git a/src/latynkatar/__init__.py b/src/latynkatar/__init__.py
new file mode 100644
index 0000000..36b8764
--- /dev/null
+++ b/src/latynkatar/__init__.py
@@ -0,0 +1,1 @@
+from .latynkatar import Cyr2Lat
\ No newline at end of file
diff --git a/latynkatar.py b/src/latynkatar/latynkatar.py
similarity index 99%
rename from latynkatar.py
rename to src/latynkatar/latynkatar.py
index b3843b8..2cd0961 100644
--- a/latynkatar.py
+++ b/src/latynkatar/latynkatar.py
@@ -10,6 +10,7 @@
     "ґ": "g",
     "д": "d",
     "ж": "ž",
+    "й": "j",
     "к": "k",
     "м": "m",
     "о": "o",


Test patch:
diff --git a/tests/test_halosnyja.py b/tests/test_halosnyja.py
new file mode 100644
index 0000000..11c8709
--- /dev/null
+++ b/tests/test_halosnyja.py
@@ -0,0 +1,6 @@
+import pytest
+from src.latynkatar import Cyr2Lat
+
+
+def test_ju():
+    assert Cyr2Lat.convert("ЮрліВец лЮбіЦь лІю п'ю") == "JurliViec lUbiĆ lIju pju"
diff --git a/tests/test_tekst.py b/tests/test_tekst.py
index b619499..9996d48 100644
--- a/tests/test_tekst.py
+++ b/tests/test_tekst.py
@@ -1,5 +1,5 @@
 import pytest
-from latynkatar import Cyr2Lat
+from src.latynkatar import Cyr2Lat
 
 # Узор узяты з часопіса PAMYŁKA: 
 # https://github.com/PAMYLKA-ZIN/pamylka-number-3/tree/main/PAMYLKA_ZIN_3_FOR_SHARING
@@ -18,9 +18,9 @@
 Heta treci numar PAMYŁKA ZIN!
 My vielmi ciešymsia, što da kamandy stvaralnikaǔ praciahvajuć dałučacca
 novyja navukoǔcy i mastaki! J my budziem radyja kožnamu novamu ǔdzielniku!
-Siabry, my redakcyjaй nadumali zapačatkavać premiju – «Bizon Higs». Tamu hety
+Siabry, my redakcyjaj nadumali zapačatkavać premiju – «Bizon Higs». Tamu hety
 numar my prysviačajem usim biełaruskim navukoǔcam i chočam anansavać premiju,
-jakaja budzie ǔvasablać saboй Biełaruś i navuku razam! Heta ǔznaharoda dla
+jakaja budzie ǔvasablać saboj Biełaruś i navuku razam! Heta ǔznaharoda dla
 biełaruskich navukoǔcaǔ i daslednikaǔ dakładnych i pryrodaznaǔčych navuk ad
 navukova-papularnaha časopisu Pamyłka Zin.
 Bolš detalaǔ apaviadaje pieršy artykuł numaru.
diff --git "a/tests/test_zy\304\207nyja.py" "b/tests/test_zy\304\207nyja.py"
index 120b1f0..6bfe8f7 100644
--- "a/tests/test_zy\304\207nyja.py"
+++ "b/tests/test_zy\304\207nyja.py"
@@ -1,10 +1,6 @@
 import pytest
-from latynkatar import Cyr2Lat
+from src.latynkatar import Cyr2Lat
 
 
 def test_l():
     assert Cyr2Lat.convert("ЛаЭлЯЛуЛіЛюЛЁлЕлЬ") == "ŁaElAŁuLiLuLOlEl"
-
-
-def test_ju():
-    assert Cyr2Lat.convert("ЮрліВец лЮбіЦь лІю п'ю") == "JurliViec lUbiĆ lIju pju"