Metadata-Version: 2.4
Name: basicnn
Version: 2026.4.30.0.4
Summary: A modular basic neural network toolkit with dataset and filesystem helpers.
Author-email: Your Name <you@example.com>
License: MIT License
        
        Copyright (c) 2026
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://pypi.org/project/basicnn/
Project-URL: Repository, https://github.com/coderelease/basicnn
Project-URL: Issues, https://github.com/coderelease/basicnn/issues
Keywords: neural-network,dataset,filesystem,pytorch
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: model
Provides-Extra: dataset
Provides-Extra: filesystem
Provides-Extra: all
Provides-Extra: dev
Requires-Dist: build>=1.2.1; extra == "dev"
Requires-Dist: pipreqs>=0.5.0; extra == "dev"
Requires-Dist: tomlkit>=0.13.2; extra == "dev"
Requires-Dist: twine>=5.1.1; extra == "dev"
Dynamic: license-file

# basicnn

basicnn is a modular Python package with three focused submodules:

- `basicnn.model`: neural network related abstractions and utilities.
- `basicnn.dataset`: general dataset and file-reading utilities.
- `basicnn.filesystem`: filesystem and path handling helpers.

## Install

Default install (includes all module dependencies):

```bash
pip install basicnn
```

You can also install with explicit module extras:

```bash
pip install "basicnn[model]"
pip install "basicnn[dataset]"
pip install "basicnn[filesystem]"
pip install "basicnn[all]"
```

For local development:

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

For development tools:

```bash
pip install -e ".[dev]"
```

## Auto Sync Dependencies

Use pipreqs-based sync script to avoid manual dependency maintenance:

```bash
python scripts/sync_deps.py
```

Optional mode examples:

```bash
python scripts/sync_deps.py --mode no-pin
python scripts/sync_deps.py --mode gt
python scripts/sync_deps.py --mode compat
```

The script updates these fields in pyproject.toml automatically:

- project.dependencies
- project.optional-dependencies.model
- project.optional-dependencies.dataset
- project.optional-dependencies.filesystem
- project.optional-dependencies.all

## Build package

```bash
python -m build
```

## Upload to PyPI

```bash
python -m twine upload dist/*
```

## One-Command Publish

Run this script to automatically:

- set version to `YYYY.MM.DD.HH.MM`
- build package artifacts
- upload to configured PyPI repository

```bash
python scripts/publish.py
```

Publish to TestPyPI:

```bash
python scripts/publish.py --repository testpypi
```

You can copy `.pypirc.example` to `~/.pypirc` and fill your token.
