Skip to main content

A Python library for Concept-Connection System (CCS) - offline-first knowledge graph management

Project description

CCS

A Python library for CCS functionality.

Installation

From source (development mode)

# Clone the repository
git clone https://github.com/yourusername/ccs.git
cd ccs

# Install in development mode
pip install -e .

# Install with development dependencies
pip install -e ".[dev]"

From PyPI (once published)

pip install ccs

Usage

# Import the main functions and classes
from ccs import example_function, ExampleClass, helper_function

# Use example_function
result = example_function("hello")
print(result)  # Output: Processed: hello

# Use ExampleClass
obj = ExampleClass("my_instance")
obj.process("some data")
print(obj)  # Output: ExampleClass(name='my_instance', data=some data)

# Use helper_function
first_item = helper_function([1, 2, 3])
print(first_item)  # Output: 1

Import specific modules

from ccs.core import ExampleClass
from ccs.utils import flatten_list, validate_input

# Flatten nested lists
flat = flatten_list([[1, 2], [3, 4]])
print(flat)  # Output: [1, 2, 3, 4]

# Validate input types
is_valid = validate_input("hello", str)
print(is_valid)  # Output: True

Project Structure

CCS-Python/
├── pyproject.toml          # Package configuration
├── README.md               # This file
├── src/
│   └── ccs/                # Main package
│       ├── __init__.py     # Package initialization & exports
│       ├── core.py         # Core functionality
│       └── utils.py        # Utility functions
├── tests/                  # Test suite
│   ├── __init__.py
│   ├── test_core.py
│   └── test_utils.py
└── docs/                   # Documentation (optional)

Development

Running tests

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run tests with coverage
pytest --cov=ccs

Code formatting

# Format code with black
black src/ tests/

# Lint with ruff
ruff check src/ tests/

Type checking

mypy src/

Building & Publishing

Build the package

pip install build
python -m build

This creates distribution files in the dist/ directory:

  • ccs-0.1.0.tar.gz (source distribution)
  • ccs-0.1.0-py3-none-any.whl (wheel distribution)

Publish to PyPI

pip install twine

# Upload to TestPyPI first (recommended)
twine upload --repository testpypi dist/*

# Upload to PyPI
twine upload dist/*

License

MIT License - see LICENSE file for details.

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

mftsccs-0.1.2.tar.gz (35.3 kB view details)

Uploaded Source

Built Distribution

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

mftsccs-0.1.2-py3-none-any.whl (45.0 kB view details)

Uploaded Python 3

File details

Details for the file mftsccs-0.1.2.tar.gz.

File metadata

  • Download URL: mftsccs-0.1.2.tar.gz
  • Upload date:
  • Size: 35.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for mftsccs-0.1.2.tar.gz
Algorithm Hash digest
SHA256 402245569c825f64f170b3e8b1377f6de4f0e081944c3c79a0d2cad7e410dc80
MD5 d0f6ec0e248ffde9bec980c8c0ef0ec8
BLAKE2b-256 76bc28736063ef0c6e6f0fb9a1abbfee6cf368d706814e15b22f0bd753485703

See more details on using hashes here.

File details

Details for the file mftsccs-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: mftsccs-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 45.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for mftsccs-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b88c1501e1cdc3f6d92f22b049f369386471af26efe87ea336d27ce64efd7452
MD5 801bda2040aa762e2f32cf9823bd3552
BLAKE2b-256 3448aa84a3fad3d28d055bebe030c3a693fae18a7960237f2d9f9b7ea11e079d

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