Skip to main content

Python librairy for parsing NooJ's dictionary files

Project description

pynooj

Python library for parsing NooJ's dictionary files.

Overview

pynooj is a Python library that parses NooJ dictionary files (.dic) and extracts lexical information including inflected forms, lemmas, grammatical categories, and morphological traits.

For more information about NooJ, visit the NooJ website.

Installation

pip install pynooj

Usage

Basic Example

from pynooj import main

# Parse a NooJ dictionary file
entries = main.read_dic("path/to/dictionary.dic")

# Each entry is a dictionary containing:
# - "inflected form": the word form
# - "lemma": the base form (optional)
# - "category": grammatical category (e.g., "V", "N", "A")
# - "traits": morphological attributes

for entry in entries:
    print(entry["inflected form"], "→", entry["lemma"])
    print(f"  Category: {entry['category']}")
    print(f"  Traits: {entry['traits']}")

Dictionary File Format

NooJ dictionary files use a comma-separated format:

inflected_form,lemma,category+Trait1=Value1+Trait2=Value2

Examples:

amo,amare,V+Theme=INF+FLX=GP1_INF+GP=1
casa,casa,N+Number=SG+Gender=F

API Reference

read_dic(path)

Parses a NooJ dictionary file and returns a list of lexical entries.

Parameters:

  • path (str): Path to the .dic file

Returns:

  • List of dictionaries, each containing:
    • "inflected form": the word form (string)
    • "lemma": the base form (string, optional)
    • "category": grammatical category (string)
    • "traits": dictionary of morphological traits (dict)

Running Tests

To run the test suite with unittest:

python -m unittest discover -s tests

Publishing to PyPI

Prerequisites

Ensure you have the necessary tools installed:

pip install build twine

Steps

  1. Update version in pyproject.toml

  2. Build the package:

    python -m build
    
  3. Upload to PyPI:

    twine upload dist/*
    
  4. Upload to TestPyPI (optional, for testing):

    twine upload --repository testpypi dist/*
    

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

License

See the LICENSE file for details.

Related Resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pynooj-0.1.1.tar.gz (3.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pynooj-0.1.1-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file pynooj-0.1.1.tar.gz.

File metadata

  • Download URL: pynooj-0.1.1.tar.gz
  • Upload date:
  • Size: 3.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for pynooj-0.1.1.tar.gz
Algorithm Hash digest
SHA256 42bd98fdaf6388f9cb512b54e763c221b99740bed7cad829e6a42745312e4e12
MD5 a44e3406d220c8d572c36a1fb93b1392
BLAKE2b-256 013753aeaa16b46428d32095c63b28e512570281c0423aa93b8cac493e49a610

See more details on using hashes here.

File details

Details for the file pynooj-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pynooj-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for pynooj-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dc6464c54a9e3933fd02023a099718f18a7174f4b03b0d6c9b7bc2bcc2d6f998
MD5 ece3b6eda6dda6251328cd53d09447cd
BLAKE2b-256 1487178dbab6c6cf65f28a63d610aaea500bbde19a994c34be7292abda0a37c5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page