Plibonigi la instalado kaj prizorgeblo de devigaj programopartoj #346

CourteousCoder · 2024-11-13T12:58:36Z

Priskribo de la Ŝanĝoj

Kreas pyproject.toml, la aktualan rekomendatan manifestan dosieron por pitonaj projektoj, laŭ PEP-518 kaj PEP-621. Legu plu pri pyproject.toml. Uzi tion estas ĝenerale preferata inter pitonaj programistoj en la komunumo. Almenaŭ aktuale.
Integri la ilon uv (kaj ĝian par-anon uvx) por administri la projekton kaj konsekvence pakaĵojn en pyproject.toml

*Rimarketo: La uvx estas konvenka sinonimo por uv tool run, komapreble al la npx komandon de npm por ĴavaSkripto

Kunsideroj por decidoj elektitaj

El la amaso da pitonaj pakaĵiloj kiuj ekzistas, mi celis ke la solvo:

Havas simplan API kajaŭ CLI por alkutimiĝi
Sekvas la popularajn PEP-ojn por pyproject.toml ol la aliaj
Ne multe devigas, ke ni ŝanĝu la disponigadon
Estas populara, ne-rompiĝema, kaj aktive subtenata
Unuigas la instaladon trans malsamaj Linuksaj operaciumoj, do ĝi povus esti aŭtomatiĝa
Simplas por integri kaj malintegri (se ni estontece eble decidus ŝanĝi ĝin denove)
Havas bon-kvalitan dokumentadon

Elektoj apartene por pitono

pipenv
poetry
pdm
hatch
uv

Elektoj kiuj pli ĝeneralas

docker entute
guix
nix flake
devenv
devbox
flox

Finfine mi decidis ke uv plej taŭgas kiel ekvilibrigo de la kunsederoj. La dokumentadon haveblas tie ĉi..

Programada detaloj

La venv nun defaŭlte nomiĝas .venv
La instalado estis iom pli aŭtomata nun (vidu ./instalilo.sh)
La pre-commit ilo eksportas la liston de devigaj program-partoj reen al requirements*.txt por, ke ĝi (espereble) ne malhelpos la aktualajn CI kaj disponigon.
Ĝi ne plu dependas de la sistema pitono, do oni ne devas instali ĝin per apt. Verŝajne ankaŭ tio veras de dnf por Fedora.
Kelkaj sistemaj pakaĵoj ĝisdatigis siajn nomojn ekde Ubuntu 16.10 kaj Debian Stretch do la README.md nun montras la novajn.
Kelkaj programoj elŝutita de PIP ne plu bezonas esti en via sistema aŭ hejma pitono pro la komandoj uv run (projekta medio) kaj uvx (apartigita medio)

Testado

Mi instalis ĝin nur de Pop OS 22.04. Tio ĉi bazas de Ubuntu 22.04 sed mi ne provis ĝin per aliaj operaciumoj. Mi tute testis per dnf
Mi testis ĝin per apt kaj ankaŭĉ per nixpkgs en malpura ŝelo.

La ĝusta versio de pitono sukcese uzatas ĉiufoje
La venv estas sukcese kreebla ĉiufoje
La pitonaj pakaĵoj estas sukcese instalataj ene de la venv ĉiufoje
Migratoj sukcese kuras kiel mi atendis.
La servilo sukcese ŝaltas sen eraroj
La loka retejo ĉe localhost aspektas bela kaj funkcias kiel mi atendis KROM la mapo
La testoj sukcesas KROM por la mapoj. Mi supozas ke ĝi estas pro manko de API ŝlosilo por mia loka medio.
`from http://api.opencagedata.com/geocode/v1/json: ERROR - 401 Client Error: Unauthorized

Estas malfrua nokte en Kalfornio en Usono nun, do mi enlitiĝos tuj. Pardonon, se mi mistajpis iomete en tiu ĉi PR.

Dankon! Kaj mi esperas ke tiu ĉi PR estas bona por nia projekto

Ligataj taskoj

Resolve #240 (la ĉefa celo)
Resolve #151 (nu, ne tute. nur ĉar mi klarigis tiujn ŝanĝojn en la README.md)

codecov · 2024-11-13T13:02:35Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.85%. Comparing base (b7298ea) to head (4131f49).

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #346      +/-   ##
==========================================
+ Coverage   80.82%   80.85%   +0.03%     
==========================================
  Files          90       90              
  Lines        6606     6606              
  Branches      829      829              
==========================================
+ Hits         5339     5341       +2     
+ Misses       1193     1192       -1     
+ Partials       74       73       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

interDist

Denove dankon por via zorga esploro kaj la detala priskribo de la konkludoj. Mi finfine havis tempon por dediĉi al tiu ĉi TP la atenton kiun ĝi meritas kaj senperturbe tralegi la proponitajn ŝanĝojn.
Sonas al mi bona la elekto de uv eĉ se ekzistas iom da kritiko kontraŭ ĝi (ĉar estas verkita en Rust). Plirapidigo estas ja signifa.

Unue ĝenerala rimarkigo: en la kodo mem ni uzas la anglan – do nomoj de funkcioj, komentoj, kaj dosiernomoj estas ĉiuj anglalingve.

Rilate uv ĝenerale: mi legis ĉe https://www.loopwerk.io/articles/2024/python-uv-revisited/ ke preferindas difini default-groups = [] kaj por ĉiu komando indiki eksplicite la deziratan grupon. Kion vi opinias pri tio?

Rilate la instalilon: mi ne tre ŝatas ke la versio de uv estas kaŝita ie meze de la skripto. Estus pli bone se ĝi aperus en, ekzemple, .uv-version kaj la skripto legu ĝin el tie. Sed mi ankaŭ vidis ke indiki la version ne estas devige. Eble la ekzakta versio ne tiom gravas? (Cetere la plej aktuala estas jam 0.5.22)

Rilate la enmetajn hokojn:

Estus pli bone se la dosieroj ĉe requirements/ estu aktualigataj nur se vere okazis ŝanĝo en la bezonataj pakaĵoj. Sed mi ne scias ĉu entute eblas detekti tion.
Mi rimarkis ke la eksporta komando perdas la specifaĵojn de la pakaĵoj. Ekzemple, estas difinita dependeco je django-anymail[postmark] sed en la rezulta prod.txt la specifigo de postmark mankas. Tio estas iom zorgiga.

Mi dankas vin pro via laboro!

interDist · 2025-01-22T19:14:22Z

.pre-commit-config.yaml

+    # Por daŭrigi, ke nia aktuala disponiga sistemon ankoraŭ povas legi de requirements.txt
+    # TODO:FAROTE Decidi ĉu ŝanĝindas tio.
+    - id: export-requirements-base
+      name: export-requirements-base


name: export requirements (base)

interDist · 2025-01-22T19:14:37Z

.pre-commit-config.yaml

+      verbose: false
+
+    - id: export-requirements-dev
+      name: export-requirements-dev


name: export requirements (dev)

interDist · 2025-01-22T19:14:57Z

.pre-commit-config.yaml

+      name: export-requirements-base
+      require_serial: true
+      language: system
+      entry: uv export --locked --no-dev -o requirements/base.txt


bv. aldonu --quiet

interDist · 2025-01-22T19:15:11Z

.pre-commit-config.yaml

+      name: export-requirements-dev
+      require_serial: true
+      language: system
+      entry: bash -c '( echo "-r base.txt"; uv export --only-dev --locked ) > requirements/dev.txt'


bv. aldonu --quiet

interDist · 2025-01-22T19:16:46Z

README.md


 Se vi vidas `eo.utf8` en la listo, la ĝusta lokaĵaro estas nun aktiva.

+### uv: ``VIRTUAL_ENV does not match the project environment path `.venv` and will be ignored``


Mi aldonis tiun ĉi sekcion – mi havas jam agorditan kaj funkciantan virtualan medion, kaj aldono de uv al ĝi ne glate paŝis.

interDist · 2025-01-22T19:30:31Z

pyproject.toml

+maintainers = [
+    { name = "Meir", email = "[email protected]" },
+    { name = "Baptiste Darthenay", email = "[email protected]" },
+    { name = "Etenil", email = "[email protected]" },
+    { name = "Chloe Shetreet", email = "[email protected]" },
+    { name = "Salman Mohammadi", email = "[email protected]" },
+]


Nur mi kaj vi estu listigitaj ĉi tie. Cetere, email ne estas deviga ŝlosilo, povas aperi nur nomo. Vi povas meti mian plenan nomon: Meir Goren.

interDist · 2025-01-22T19:32:59Z

pyproject.toml

+    "uv>=0.5.1",
+]
+
+# TODO:FAROTE Konsideri kiel unuigi la agordojn kaj skriptojn de setup.cf, fabfile.py, kaj pyproject.toml ĉi tien.


Plejparto de setup.cfg (krom flake8) povas translokiĝi al pyproject.toml, sed tio estu aparta projekteto. La skripto fabfile.py, aliflanke, estas tute alia besto – ĝi estas uzata de fab kaj estas aro de taskoj por fab. Ĝi devos resti.

interDist · 2025-01-22T19:42:57Z

pyproject.toml

+urls.documentation = "https://github.com/tejoesperanto/pasportaservo/blob/master/README.md"
+urls.issues = "https://github.com/tejoesperanto/pasportaservo/issues"
+urls.source = "https://github.com/tejoesperanto/pasportaservo"


aldoneblas urls.homepage = "https://www.pasportaservo.org"

interDist · 2025-01-22T19:51:23Z

pyproject.toml

+classifiers = [
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+]


Mi opinias ke la versio de Python ne tiom gravas, finfine PS ne estas disponigata biblioteko. Trarigardinte https://pypi.org/classifiers ŝajnas al mi ke plej taŭgus:

Framework :: Django Programming Language :: Python Development Status :: 5 - Production/Stable License :: OSI Approved :: GNU Affero General Public License v3 Natural Language :: Esperanto

interDist · 2025-01-22T19:57:33Z

pyproject.toml

+keywords = [
+    "django", "postgresql", "saas", "pasporta", "servo", "esperanto", "tejo", "zamenhof",
+    "tutmonda", "junulara", "organizo", "lingvo", "interparolo", "internacia", "loĝado", "vojaĝi", "gastigo", "mapo", "retejo",
+    "passport", "service", "global", "youth", "orginization", "language", "exchange", "international", "lodging", "travel", "hospitality", "map", "website", "online",
+    # TODO:FAROTE: Ĉu pli da lingvaj tradukoj aldonendas? Ebla nur la denaskaj lingvoj de niaj kontribuantoj, aŭ eble nur la plej vidataj je GitHub.
+]


Estas multaj ne-necesaj ŝlosilvortoj laŭ mi. Mi tenus la liston laŭeble baza:

hospitality, accommodation, travel, esperanto, gastigo, vojaĝoj

interDist · 2025-01-23T00:56:01Z

Aĥ, ja, mi forgesis ankoraŭ kelkajn etajn aferojn:

forprenu Resolve #151 el la priskribo de la TP, por ke tiu atentindaĵo restu malfermita.
necesas aktualigi la version de psycopg2 al 2.9.10.
mankas la komando uv run ./manage.py compilejsi18n -l eo kiel lasta paŝo de instalado, en ambaŭ instalilo kaj README.

CourteousCoder added 5 commits November 10, 2024 12:39

pravalorizas manifestajn dosierojn pyproject.toml kaj .python-version

72d2c30

Aldonas dependecojn al pyproject.toml de la requirements/*.txt

0506bd6

Integras uv-on por mastrumi la projekton kaj devigajn pakaĵojn

0d71560

Ĝisdatigas la dokumentaĵon pri la uzo de uv

f5913eb

Ebligas, ke ankaŭ requirements.txt ankoraŭ uzeblu en CI kaj disponigoj

b7f1ebc

CourteousCoder mentioned this pull request Nov 13, 2024

[Pliboniga ideo]: Uzu ilon por virtualaj medioj kaj devigaj programo-partoj #240

Open

Korektas README

4131f49

interDist force-pushed the issue-240-ek-uzi-pakajxilon-pitonan branch from de0c253 to 4131f49 Compare January 22, 2025 06:10

interDist requested changes Jan 23, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Plibonigi la instalado kaj prizorgeblo de devigaj programopartoj #346

Plibonigi la instalado kaj prizorgeblo de devigaj programopartoj #346

CourteousCoder commented Nov 13, 2024 •

edited

Loading

codecov bot commented Nov 13, 2024 •

edited

Loading

interDist left a comment

interDist Jan 22, 2025

interDist Jan 22, 2025

interDist Jan 22, 2025

interDist Jan 22, 2025

interDist Jan 22, 2025

interDist Jan 22, 2025

interDist Jan 22, 2025

interDist Jan 22, 2025

interDist Jan 22, 2025

interDist Jan 22, 2025

interDist commented Jan 23, 2025 •

edited

Loading


		Se vi vidas `eo.utf8` en la listo, la ĝusta lokaĵaro estas nun aktiva.

		### uv: ``VIRTUAL_ENV does not match the project environment path `.venv` and will be ignored``

Plibonigi la instalado kaj prizorgeblo de devigaj programopartoj #346

Are you sure you want to change the base?

Plibonigi la instalado kaj prizorgeblo de devigaj programopartoj #346

Conversation

CourteousCoder commented Nov 13, 2024 • edited Loading

Priskribo de la Ŝanĝoj

Kunsideroj por decidoj elektitaj

Elektoj apartene por pitono

Elektoj kiuj pli ĝeneralas

Programada detaloj

Testado

Ligataj taskoj

codecov bot commented Nov 13, 2024 • edited Loading

Codecov Report

interDist left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

interDist commented Jan 23, 2025 • edited Loading

CourteousCoder commented Nov 13, 2024 •

edited

Loading

codecov bot commented Nov 13, 2024 •

edited

Loading

interDist commented Jan 23, 2025 •

edited

Loading