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
Release history Release notifications | RSS feed
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.12.tar.gz
(54.8 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
mftsccs-0.1.12-py3-none-any.whl
(70.4 kB
view details)
File details
Details for the file mftsccs-0.1.12.tar.gz.
File metadata
- Download URL: mftsccs-0.1.12.tar.gz
- Upload date:
- Size: 54.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
93ed7cff4a03d4ff126c813cda1a6ff8a540de845253fed84e181b3be93c850b
|
|
| MD5 |
2e3cdd0933c1f0e3029d247baeeecf70
|
|
| BLAKE2b-256 |
7f419bd8083a69f0655d8671a062d59e4c3978c4ad69afd9ffdd4be5223dc9d7
|
File details
Details for the file mftsccs-0.1.12-py3-none-any.whl.
File metadata
- Download URL: mftsccs-0.1.12-py3-none-any.whl
- Upload date:
- Size: 70.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6e01fb9c03d65377a9e5f27d2fe8507f9a378303a05fa43fe832a0dab8da466e
|
|
| MD5 |
b82afc2198d8d6a4c2ceff802893b243
|
|
| BLAKE2b-256 |
6a0aefead191d117345d3d0cef34e5baa182157422c977a2e73b367656252718
|