Metadata-Version: 2.5
Name: codenerix-lib
Version: 1.1.0
Summary: Basic libraries used by CODENERIX.
Project-URL: Homepage, https://github.com/codenerix/codenerix-lib
Project-URL: Source, https://github.com/codenerix/codenerix-lib
Project-URL: Changelog, https://github.com/codenerix/codenerix-lib/blob/master/CHANGELOG
Author-email: Juanmi Taboada <juanmi@juanmitaboada.com>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: codenerix
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: colorama
Requires-Dist: nltk
Requires-Dist: pycryptodomex
Requires-Dist: textnorm
Requires-Dist: unidecode
Description-Content-Type: text/markdown

# codenerix-lib

[![PyPI](https://img.shields.io/pypi/v/codenerix-lib?color=blue)](https://pypi.org/project/codenerix-lib/)
[![CI](https://github.com/codenerix/codenerix-lib/actions/workflows/ci.yml/badge.svg)](https://github.com/codenerix/codenerix-lib/actions/workflows/ci.yml)
[![Coverage](https://codecov.io/gh/codenerix/codenerix-lib/branch/master/graph/badge.svg)](https://codecov.io/gh/codenerix/codenerix-lib)
[![Python versions](https://img.shields.io/pypi/pyversions/codenerix-lib)](https://pypi.org/project/codenerix-lib/)
[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-yellow)](https://opensource.org/license/apache-2.0)
[![Changelog](https://img.shields.io/badge/changelog-CHANGELOG-orange.svg)](https://github.com/codenerix/codenerix-lib/blob/master/CHANGELOG)

Codenerix LIB is a base module of libraries used by [CODENERIX](https://www.codenerix.com/). It is a very useful library for any project and you can use it without [CODENERIX](https://www.codenerix.com). You can visit the project at [GitHub Django CODENERIX](https://github.com/codenerix/django-codenerix).

[![CODENERIX](https://github.com/codenerix/django-codenerix/raw/master/codenerix/static/codenerix/img/codenerix.png)](https://www.codenerix.com)

## Quickstart

1. Install this package:

   ```bash
   pip install codenerix-lib
   ```

2. If you use `codenerix_lib.normalizers`, install the NLTK stopwords corpus once per machine (it is not downloaded automatically):

   ```bash
   python -m nltk.downloader stopwords
   python -c "import nltk; nltk.data.find('corpora/stopwords'); print('ok')"
   ```

   The downloader exits successfully even when the download fails, so use the second command to check it. Behind an HTTP proxy, nltk 3.10 or later refuses to download unless `NLTK_ALLOW_PROXIED_URLOPEN=1` is set.

3. Since Codenerix LIB is a library, you only need to import its parts into your project and use them.

[Contact with us](https://codenerix.com/contact/).
