Skip to content

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Genos SDK

Python SDK for interacting with the Genos platform.

This package provides a clean, testable, and extensible interface for integrating Genos services into Python applications.


📦 Project Structure

genos-sdk/
│
├── genossdk/        # Core SDK implementation
├── tests/           # Unit and integration tests
├── pyproject.toml   # Poetry configuration
├── poetry.lock      # Dependency lock file
└── README.md

🚀 Installation

Using Poetry (Recommended)

poetry add genos-sdk

Or for local development:

git clone https://github.com/<your-username>/genos-sdk.git
cd genos-sdk
poetry install

🛠 Development Setup

  1. Install Poetry if not already installed:

    pip install poetry
  2. Install dependencies:

    poetry install
  3. Activate virtual environment:

    poetry shell

🧪 Running Tests

poetry run pytest

To run with coverage:

poetry run pytest --cov=genossdk

📖 Usage Example

from genossdk import Client

client = Client(api_key="your-api-key")

response = client.some_method()
print(response)

Replace some_method() with actual SDK functionality once implemented.


⚙️ Configuration

Authentication and configuration can typically be provided through:

  • Environment variables
  • Direct constructor parameters
  • Configuration files (if supported)

Example:

export GENOS_API_KEY=your-api-key

📚 Features

  • Modular architecture
  • Clean separation between API logic and transport
  • Test coverage via tests/
  • Poetry-based dependency management

🔐 Security

  • Do not commit API keys or secrets.
  • Use environment variables or secret managers.
  • Rotate credentials if exposed.

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Add tests for new functionality
  4. Ensure tests pass
  5. Open a pull request

Landry Some
GitHub: https://github.com/landry-some

About

Python SDK for interacting with the Genos platform

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages