comtext-sr-pseudonymizer 0.5.3__tar.gz

comtext_sr_pseudonymizer-0.5.3/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

comtext_sr_pseudonymizer-0.5.3/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: comtext-sr-pseudonymizer
+Version: 0.5.3
+Summary: Pseudonymization library for COMtext.SR
+Author-email: Aleksandra Todorović <todorovic.aleksandra.1706@gmail.com>, dr Vuk Batanović <vukbatanovic@gmail.com>
+License-Expression: Apache-2.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# COMtext.SR pseudonimizator
+
+COMtext.SR pseudonimizator je programska biblioteka za pseudonimizaciju poverljivih podatka, tj. njihovu zamenu izmišljenim podacima istog tipa, u pravno-administrativnim tekstovima na srpskom jeziku. Ova biblioteka je razvijena u okviru projekta [COMtext.SR](https://github.com/ICEF-NLP/COMtext.SR).
+
+COMtext.SR pseudonimizator je u stanju da izvrši pseudonimizaciju sledećih tipova poverljivih podataka:
+- Imena i prezimena osoba
+- Adresa i toponima
+- Naziva kompanija i nevladinih organizacija
+- Identifikatora fizičkih lica (JMBG, broj lične karte/pasoša) i pravnih lica (PIB, matični broj)
+- Brojeva registarskih tablica
+- Brojeva parcela
+- Novčanih iznosa 
+- Brojeva računa u banci
+- Kontakt informacija - brojeva telefona, URLova i email adresa
+- Datuma
+
+Za izvršavanje biblioteke neophodno je korišćenje Python verzije 3.11. ili novije.
+ 
+## Ulazni podaci
+Rad pseudonimizatora se zasniva na pravilno obeleženim imenovanim entitetima za svaki od tipova poverljivih informacija koje treba pseudonimizovati. COMtext.SR pseudonimizator se stoga oslanja na prethodno korišćenje modela za prepoznavanje imenovanih entiteta u pravno-administrativnim tekstovima koji su izrađeni u okviru COMtext.SR projekta.
+
+Priprema dokumenta za pseudonimizaciju podrazumeva da se sirov tekstualni sadržaj dokumenta prethodno tokenizuje i propusti kroz COMtext.SR.legal modele za morfosintaktičko obeležavanje reči, lematizaciju i prepoznavanje imenovanih entiteta radi dobijanja potrebnih oznaka. Alternativno, moguće je za te potrebe adaptirati neke druge modele istog tipa za obradu tekstova na srpskom, tako da njihov izlaz odgovara oznakama koje koriste COMtext.SR modeli.
+
+Biblioteka očekuje da ulazni podaci budu formatirani u .conllu formatu, sa sledećim kolonama:
+1. Redni broj tokena
+2. Token
+3. Lema
+4. Morfosintaktički tag (po [MULTEXT-East v6](http://nl.ijs.si/ME/V6/) standardu)
+5. Imenovani entiteti (prema šemi entiteta iz COMtext.SR projekta, obeleženi po IOB2 standardu)
+
+Ukoliko ulazni .conllu fajl sadrži više dokumenata, početak svakog dokumenta bi trebalo da bude naznačen pomoću:
+```
+# newdoc id = DOC123
+```
+gde je **DOC123** proizvoljan identifikator posmatranog dokumenta.
+
+## Način rada
+COMtext.SR pseudonimizator se u radu oslanja na [srLex](http://hdl.handle.net/11356/1233), najveći javno dostupni flektivni leksikon srpskog jezika. To mu omogućava da izvrši zamenu imena i prezimena osoba i adresa u adekvatnom padežnom obliku u kome se originalni entitet nalazio. 
+
+Identifikatori fizičkih i pravnih lica (JMBG, broj lične karte/pasoša, PIB, matični broj) se zamenjuju vodeći računa o zadržavanju validnog formata navedenih identifikatora. Isto važi i za brojeve registarskih tablica, parcela, računa u banci. Pritom, zamene identifikatora fizičkih i pravnih lica se uvek generišu sa pogrešnom kontrolnom cifrom, tako da se izbegne preklapanje sa nekim drugim realno postojećim vrednostima identifikatora.
+
+COMtext.SR pseudonimizator koristi vreme pokretanja i ID ulaznog dokumenta kao *seed* vrednosti za interni generator slučajnih brojeva. To omogućava da zamene budu slučajne, tj. da se razlikuju između dva pokretanja pseudonimizatora nad istim ulaznim podacima, a da istovremeno budu konzistentne, tako da se u okviru istog dokumenta jedan isti ulazni entitet uvek zamenjuje fiksnim zamenskim entitetom.
+
+## Ograničenja
+* **Prisvojni pridevi:** Zbog izuzetno ograničene pokrivenosti prisvojnih prideva izvedenih iz ličnih imena u srLex leksikonu, COMtext.SR pseudonimizator trenutno nije u stanju da izvrši zamenu takvih oblika imenovanih entiteta. 
+* **Toponimi:** Pseudonimizator je trenutno ograničen u zameni toponima na nazive 145 gradova i opština u Republici Srbiji. Pored toga, biblioteka trenutno ne vrši zamenu toponima koji se javljaju u okviru naziva institucija tj. u okviru imenovanih entiteta tog tipa, dok se za toponime u okviru zvaničnih naziva sudova vrši zamena.
+* **Kompanije:** Zamena imena realnih kompanija i nevladinih organizacija je trenutno ograničena na njihov oblik u nominativu.
+* **Pravna dokumenta:** Pseduonimizacija poverljivih informacija sadržanih u okviru pominjanja pravnih dokumenata, poput opštih i pojedinačnih pravnih akata, trenutno nije podržana.
+ 
+## Instalacija i pokretanje
+COMtext.SR pseudonimizator je dostupan u vidu PyPI paketa koji se može instalirati sledećom komandom:
+ ```
+pip install comtext-sr-pseudonymizer
+```
+
+### Pokretanje
+Biblioteka se može pokrenuti direktno iz komandne linije komandom: `comtext-sr-pseudonymizer`
+#### Argumenti 
+
+| Argument | Skraćenica | Opis |
+| :--- | :--- | :--- |
+|  &#45;&#45;input | `-i` | **Obavezno.** Putanja do `.conllu` fajla koji se pseudonimizuje. |
+| &#45;&#45;output | `-o` | Direktorijum za čuvanje rezultata (default: `results`). |
+| &#45;&#45;types | `-t` | Opciona lista entiteta (npr. `PER ADR DATE`). Ako se izostavi, svi podržani tipovi se pseudonimizuju. |
+#### Primer upotrebe
+```bash
+comtext-sr-pseudonymizer --input ./data/my_text.conllu --output ./my_results --types PER TOP ADR
+```
+
+### Izlazni podaci
+Biblioteka generiše dva izlazna fajla prilikom svakog izvršavanja. Prvi fajl sadrži pseudonimizovane podatke, dok drugi sadrži spisak izvršenih zamena.
+
+#### 1. Pseudonimizovani tekst - **File:** `[TIMESTAMP].conllu`
+Ovo je glavni izlazni fajl. On zadržava strukturu ulaznog fajla, ali zamenjuje poverljive informacije pseudonimizovanim vrednostima.
+
+* **Format**: Tabulatorom razdvojen format sa 3 kolone (Redni broj tokena u rečenici, pseudonimizovan token, NER tag po IOB2 formatu).
+* **Metapodaci**: Svi originalni metapodaci (npr. # sent_id, # text) su sačuvani i modifikovani shodno unetim zamenskim vrednostima.
+* **Logika**: Transformišu se samo tokeni koji pripadaju nekom imenovanom entitetu (B-X, I-X); tokeni sa oznakom "O" ostaju nepromenjeni.
+
+Primer izlaznog formata:
+```text
+# sent_id = vA001-s1
+# text = DIFOVIT DOO ul. Lazara Lopičića 70 21480 Srbobran
+1	DIFOVIT	B-COM
+2	DOO	I-COM
+3	ul.	B-ADR
+4	Lazara	I-ADR
+5	Lopičića	I-ADR
+6	70	I-ADR
+7	21480	I-ADR
+8	Srbobran	I-ADR
+```
+
+#### 2. Spisak izvršenih zamena - **File:** `[TIMESTAMP]_replacements.tsv`
+Ovaj fajl služi kao izveštaj o mapiranju, omogućavajući direktno poređenje originalnih podataka sa generisanim zamenama.
+
+Struktura fajla:
+| Kolona | Opis |
+| :--- | :--- |
+| `doc_id` | Jedinstveni identifikator izvornog dokumenta (npr, `vA001`). |
+| `sentence_id` | Identifikator konkretne rečenice (npr. `vA001-s1`). |
+| `start_token_num` | Indeks prvog tokena u entitetu. |
+| `end_token_num` | Indeks poslednjeg tokena u entitetu. |
+| `original_text` | Izvorni tekst entiteta (može se sastojati od više reči). |
+| `entity_group` | Kategorija imenovanih entiteta prema COMtext.SR šemi (npr. `COM`, `ADR`, `DATE`). |
+| `anonymized_text` | Zamena koju je generisala biblioteka. |
+
+Primer formata:
+```text
+doc_id	sentence_id	start_token_num	end_token_num	original_text	entity_group	anonymized_text
+vA001	vA001-s1	1	4	Trans Impex Trade d.o.o.	COM	DIFOVIT DOO
+vA001	vA001-s1	5	11	Bul. Vojvode Stepe 123/2 21000 Novi Sad	ADR	ul. Lazara Lopičića 70 21480 Srbobran
+vA001	vA001-s12	2	3	Novom Sadu	TOP	Srbobranu
+vA001	vA001-s12	5	9	dana 1. 2. 2011. godine	DATE	dana 03. 02. 2016. godine
+vA001	vA001-s3	12	18	Trans Impex Trade d.o.o. iz Novog Sada	COM	DIFOVIT DOO
+vA001	vA001-s3	21	22	Petar Petrović	PER	Jandre Medurić
+vA001	vA001-s3	24	25	Novog Sada	TOP	Srbobrana
+```
+
+## Autorstvo
+COMtext.SR pseudonimizator je izrađen od strane članova Grupe za obradu prirodnih jezika u okviru [Inovacionog centra Elektrotehničkog fakulteta u Beogradu (ICEF)](https://www.ic.etf.bg.ac.rs/):
+- [Aleksandra Todorović](mailto:aleksandra.todorovic@ic.etf.bg.ac.rs)
+- [dr Vuk Batanović](mailto:vuk.batanovic@ic.etf.bg.ac.rs)
+
+## Licenca
+COMtext.SR pseudonimizator je dostupan pod licencom Apache 2.0, što znači da se može slobodno koristiti za bilo koje svrhe, uključujući i komercijalne, uz navođenje informacija o autorstvu.
+
+## Zahvalnost
+Izrada COMtext.SR pseudonimizatora je omogućena zahvaljujući podršci [Fondacije Registar nacionalnog internet domena Srbije - RNIDS](http://www.rnids.rs/). 

comtext_sr_pseudonymizer-0.5.3/README.md

@@ -0,0 +1,129 @@
+# COMtext.SR pseudonimizator
+
+COMtext.SR pseudonimizator je programska biblioteka za pseudonimizaciju poverljivih podatka, tj. njihovu zamenu izmišljenim podacima istog tipa, u pravno-administrativnim tekstovima na srpskom jeziku. Ova biblioteka je razvijena u okviru projekta [COMtext.SR](https://github.com/ICEF-NLP/COMtext.SR).
+
+COMtext.SR pseudonimizator je u stanju da izvrši pseudonimizaciju sledećih tipova poverljivih podataka:
+- Imena i prezimena osoba
+- Adresa i toponima
+- Naziva kompanija i nevladinih organizacija
+- Identifikatora fizičkih lica (JMBG, broj lične karte/pasoša) i pravnih lica (PIB, matični broj)
+- Brojeva registarskih tablica
+- Brojeva parcela
+- Novčanih iznosa 
+- Brojeva računa u banci
+- Kontakt informacija - brojeva telefona, URLova i email adresa
+- Datuma
+
+Za izvršavanje biblioteke neophodno je korišćenje Python verzije 3.11. ili novije.
+ 
+## Ulazni podaci
+Rad pseudonimizatora se zasniva na pravilno obeleženim imenovanim entitetima za svaki od tipova poverljivih informacija koje treba pseudonimizovati. COMtext.SR pseudonimizator se stoga oslanja na prethodno korišćenje modela za prepoznavanje imenovanih entiteta u pravno-administrativnim tekstovima koji su izrađeni u okviru COMtext.SR projekta.
+
+Priprema dokumenta za pseudonimizaciju podrazumeva da se sirov tekstualni sadržaj dokumenta prethodno tokenizuje i propusti kroz COMtext.SR.legal modele za morfosintaktičko obeležavanje reči, lematizaciju i prepoznavanje imenovanih entiteta radi dobijanja potrebnih oznaka. Alternativno, moguće je za te potrebe adaptirati neke druge modele istog tipa za obradu tekstova na srpskom, tako da njihov izlaz odgovara oznakama koje koriste COMtext.SR modeli.
+
+Biblioteka očekuje da ulazni podaci budu formatirani u .conllu formatu, sa sledećim kolonama:
+1. Redni broj tokena
+2. Token
+3. Lema
+4. Morfosintaktički tag (po [MULTEXT-East v6](http://nl.ijs.si/ME/V6/) standardu)
+5. Imenovani entiteti (prema šemi entiteta iz COMtext.SR projekta, obeleženi po IOB2 standardu)
+
+Ukoliko ulazni .conllu fajl sadrži više dokumenata, početak svakog dokumenta bi trebalo da bude naznačen pomoću:
+```
+# newdoc id = DOC123
+```
+gde je **DOC123** proizvoljan identifikator posmatranog dokumenta.
+
+## Način rada
+COMtext.SR pseudonimizator se u radu oslanja na [srLex](http://hdl.handle.net/11356/1233), najveći javno dostupni flektivni leksikon srpskog jezika. To mu omogućava da izvrši zamenu imena i prezimena osoba i adresa u adekvatnom padežnom obliku u kome se originalni entitet nalazio. 
+
+Identifikatori fizičkih i pravnih lica (JMBG, broj lične karte/pasoša, PIB, matični broj) se zamenjuju vodeći računa o zadržavanju validnog formata navedenih identifikatora. Isto važi i za brojeve registarskih tablica, parcela, računa u banci. Pritom, zamene identifikatora fizičkih i pravnih lica se uvek generišu sa pogrešnom kontrolnom cifrom, tako da se izbegne preklapanje sa nekim drugim realno postojećim vrednostima identifikatora.
+
+COMtext.SR pseudonimizator koristi vreme pokretanja i ID ulaznog dokumenta kao *seed* vrednosti za interni generator slučajnih brojeva. To omogućava da zamene budu slučajne, tj. da se razlikuju između dva pokretanja pseudonimizatora nad istim ulaznim podacima, a da istovremeno budu konzistentne, tako da se u okviru istog dokumenta jedan isti ulazni entitet uvek zamenjuje fiksnim zamenskim entitetom.
+
+## Ograničenja
+* **Prisvojni pridevi:** Zbog izuzetno ograničene pokrivenosti prisvojnih prideva izvedenih iz ličnih imena u srLex leksikonu, COMtext.SR pseudonimizator trenutno nije u stanju da izvrši zamenu takvih oblika imenovanih entiteta. 
+* **Toponimi:** Pseudonimizator je trenutno ograničen u zameni toponima na nazive 145 gradova i opština u Republici Srbiji. Pored toga, biblioteka trenutno ne vrši zamenu toponima koji se javljaju u okviru naziva institucija tj. u okviru imenovanih entiteta tog tipa, dok se za toponime u okviru zvaničnih naziva sudova vrši zamena.
+* **Kompanije:** Zamena imena realnih kompanija i nevladinih organizacija je trenutno ograničena na njihov oblik u nominativu.
+* **Pravna dokumenta:** Pseduonimizacija poverljivih informacija sadržanih u okviru pominjanja pravnih dokumenata, poput opštih i pojedinačnih pravnih akata, trenutno nije podržana.
+ 
+## Instalacija i pokretanje
+COMtext.SR pseudonimizator je dostupan u vidu PyPI paketa koji se može instalirati sledećom komandom:
+ ```
+pip install comtext-sr-pseudonymizer
+```
+
+### Pokretanje
+Biblioteka se može pokrenuti direktno iz komandne linije komandom: `comtext-sr-pseudonymizer`
+#### Argumenti 
+
+| Argument | Skraćenica | Opis |
+| :--- | :--- | :--- |
+|  --input | `-i` | **Obavezno.** Putanja do `.conllu` fajla koji se pseudonimizuje. |
+| --output | `-o` | Direktorijum za čuvanje rezultata (default: `results`). |
+| --types | `-t` | Opciona lista entiteta (npr. `PER ADR DATE`). Ako se izostavi, svi podržani tipovi se pseudonimizuju. |
+#### Primer upotrebe
+```bash
+comtext-sr-pseudonymizer --input ./data/my_text.conllu --output ./my_results --types PER TOP ADR
+```
+
+### Izlazni podaci
+Biblioteka generiše dva izlazna fajla prilikom svakog izvršavanja. Prvi fajl sadrži pseudonimizovane podatke, dok drugi sadrži spisak izvršenih zamena.
+
+#### 1. Pseudonimizovani tekst - **File:** `[TIMESTAMP].conllu`
+Ovo je glavni izlazni fajl. On zadržava strukturu ulaznog fajla, ali zamenjuje poverljive informacije pseudonimizovanim vrednostima.
+
+* **Format**: Tabulatorom razdvojen format sa 3 kolone (Redni broj tokena u rečenici, pseudonimizovan token, NER tag po IOB2 formatu).
+* **Metapodaci**: Svi originalni metapodaci (npr. # sent_id, # text) su sačuvani i modifikovani shodno unetim zamenskim vrednostima.
+* **Logika**: Transformišu se samo tokeni koji pripadaju nekom imenovanom entitetu (B-X, I-X); tokeni sa oznakom "O" ostaju nepromenjeni.
+
+Primer izlaznog formata:
+```text
+# sent_id = vA001-s1
+# text = DIFOVIT DOO ul. Lazara Lopičića 70 21480 Srbobran
+1	DIFOVIT	B-COM
+2	DOO	I-COM
+3	ul.	B-ADR
+4	Lazara	I-ADR
+5	Lopičića	I-ADR
+6	70	I-ADR
+7	21480	I-ADR
+8	Srbobran	I-ADR
+```
+
+#### 2. Spisak izvršenih zamena - **File:** `[TIMESTAMP]_replacements.tsv`
+Ovaj fajl služi kao izveštaj o mapiranju, omogućavajući direktno poređenje originalnih podataka sa generisanim zamenama.
+
+Struktura fajla:
+| Kolona | Opis |
+| :--- | :--- |
+| `doc_id` | Jedinstveni identifikator izvornog dokumenta (npr, `vA001`). |
+| `sentence_id` | Identifikator konkretne rečenice (npr. `vA001-s1`). |
+| `start_token_num` | Indeks prvog tokena u entitetu. |
+| `end_token_num` | Indeks poslednjeg tokena u entitetu. |
+| `original_text` | Izvorni tekst entiteta (može se sastojati od više reči). |
+| `entity_group` | Kategorija imenovanih entiteta prema COMtext.SR šemi (npr. `COM`, `ADR`, `DATE`). |
+| `anonymized_text` | Zamena koju je generisala biblioteka. |
+
+Primer formata:
+```text
+doc_id	sentence_id	start_token_num	end_token_num	original_text	entity_group	anonymized_text
+vA001	vA001-s1	1	4	Trans Impex Trade d.o.o.	COM	DIFOVIT DOO
+vA001	vA001-s1	5	11	Bul. Vojvode Stepe 123/2 21000 Novi Sad	ADR	ul. Lazara Lopičića 70 21480 Srbobran
+vA001	vA001-s12	2	3	Novom Sadu	TOP	Srbobranu
+vA001	vA001-s12	5	9	dana 1. 2. 2011. godine	DATE	dana 03. 02. 2016. godine
+vA001	vA001-s3	12	18	Trans Impex Trade d.o.o. iz Novog Sada	COM	DIFOVIT DOO
+vA001	vA001-s3	21	22	Petar Petrović	PER	Jandre Medurić
+vA001	vA001-s3	24	25	Novog Sada	TOP	Srbobrana
+```
+
+## Autorstvo
+COMtext.SR pseudonimizator je izrađen od strane članova Grupe za obradu prirodnih jezika u okviru [Inovacionog centra Elektrotehničkog fakulteta u Beogradu (ICEF)](https://www.ic.etf.bg.ac.rs/):
+- [Aleksandra Todorović](mailto:aleksandra.todorovic@ic.etf.bg.ac.rs)
+- [dr Vuk Batanović](mailto:vuk.batanovic@ic.etf.bg.ac.rs)
+
+## Licenca
+COMtext.SR pseudonimizator je dostupan pod licencom Apache 2.0, što znači da se može slobodno koristiti za bilo koje svrhe, uključujući i komercijalne, uz navođenje informacija o autorstvu.
+
+## Zahvalnost
+Izrada COMtext.SR pseudonimizatora je omogućena zahvaljujući podršci [Fondacije Registar nacionalnog internet domena Srbije - RNIDS](http://www.rnids.rs/). 

comtext_sr_pseudonymizer-0.5.3/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "comtext-sr-pseudonymizer"
+version = "0.5.3"
+authors = [
+  { name="Aleksandra Todorović", email="todorovic.aleksandra.1706@gmail.com" },
+  { name="dr Vuk Batanović", email="vukbatanovic@gmail.com" },
+
+]
+description = "Pseudonymization library for COMtext.SR"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"comtext_sr_pseudonymizer" = [
+    "data/*.tsv", 
+    "data/*.txt",
+    "data/*.pkl",
+    "data/lookup/*",
+    "data/replacement/*"
+]
+
+[project.scripts]
+comtext-sr-pseudonymizer = "comtext_sr_pseudonymizer.main:main"

comtext_sr_pseudonymizer-0.5.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

comtext_sr_pseudonymizer-0.5.3/src/comtext_sr_pseudonymizer/__init__.py

@@ -0,0 +1 @@
+from comtext_sr_pseudonymizer.main import run_anonymization