synaptik 0.1.0

A Python library for neural connections, memory formation, and intelligence

Synaptik

A Python library for neural connections, memory formation, and intelligence.

Installation

Install from PyPI:

pip install synaptik

Or install from source:

git clone https://github.com/hemprasadbadgujar/synaptik.git
cd synaptik
pip install -e .

Quick Start

from synaptik import hello_world

print(hello_world())
# Output: Hello, World! Welcome to Synaptik!

Development

Setup Development Environment

git clone https://github.com/hemprasadbadgujar/synaptik.git
cd synaptik
pip install -e ".[dev]"

Running Tests

pytest

Publishing to PyPI

This package is automatically published to PyPI when a new release is created on GitHub.

Manual Publishing

1. Update the version in pyproject.toml and setup.py
2. Build the package:

   python -m build
   

3. Upload to PyPI:

   python -m twine upload dist/*
   

Automatic Publishing via GitHub Actions

The package is automatically published when you:

1. Create a new release on GitHub (tagged release)
2. Or manually trigger the workflow from GitHub Actions

Note: You need to configure PyPI trusted publishing:

1. Go to PyPI → Account Settings → API tokens
2. Add a new API token with "Trusted publishing"
3. Add your GitHub repository to the trusted publishers

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Author

Hemprasad Badgujar