Metadata-Version: 2.4
Name: ticrobe.utils
Version: 26.4.5
Summary: Shared utility package for tX projects.
Author: techist
License: Proprietary - Internal Use Only
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Dynamic: license-file

# ticrobe.utils

Reusable Python utilities for other tX projects.

This package is intended for private/internal use only.

Do not publish it to the public PyPI index if you want access limited to you
or your company.

Python import:

```python
from ticrobe.utils import *
```

## Local development

```bash
pip install -e .
```

## Private distribution

Recommended options:

- Keep the GitHub repository private and install from GitHub using SSH
- Publish to a private package registry such as GitHub Packages or an internal PyPI server

Example install from a private GitHub repository:

```bash
pip install "git+ssh://git@github.com/ticrobe1/t2.1-tX.utils.git#subdirectory=src/tX.tUtils"
```

## Build compiled wheels with Cython

This package is configured to compile its implementation modules into binary
extensions for distribution.

```bash
python -m pip install --upgrade pip
python -m pip install Cython build twine
python -m build --wheel --no-isolation
```

The compiled wheel will be written to `dist/`.

Important:

- Upload the wheel, not a source distribution, if you do not want to publish
  the `.py` implementation files.
- Cython makes the code much harder to read, but it does not provide perfect
  source-code secrecy. A determined reverse engineer can still inspect native
  binaries.

## Access control note

Package metadata alone cannot make a package private. Privacy is enforced by
where you host it:

- Private GitHub repo: only authorized GitHub users can install it
- Private registry: only users with credentials can download it
- Public PyPI: anyone can install it
