sdif-db

SDIF Database Manager.

This library provides tools to manage and interact with SDIF (Standardized Data Interoperable Format) databases.

Table of Contents

• Installation
• Usage
  • Command Line Interface (CLI)
  • As a Library
• Contributing
• License
• Contact

Installation

Prerequisites

• Python 3.9 or higher.

From PyPI (Recommended)

To install the latest stable version of sdif-db from PyPI:

pip install sdif-db

From Source (for Development)

If you want to contribute to sdif-db or need the latest development version:

1. Clone the repository:

   git clone https://github.com/syncpulse-solutions/satif.git
   cd satif/libs/sdif
   

2. Install dependencies using Poetry: Make sure you have Poetry installed.

   poetry install
   

   This will create a virtual environment and install all necessary dependencies, including development tools. Alternatively, you can use the Makefile command:

   make install
   

Usage

sdif-db can be used both as a Python library in your projects.

As a Library

You can import and use sdif-db components in your Python code.

from sdif_db import SDIFDatabase

try:
    with SDIFDatabase(path_to_your_sqlite_file) as db:
        # Perform operations
        data = db.query("SELECT * FROM your_table")
        print(data)
except Exception as e:
    print(f"An error occurred: {e}")

(More detailed examples and API documentation will be provided as the library evolves.)

Contributing

Contributions are welcome! Whether it's bug reports, feature requests, or code contributions, please feel free to get involved.

Contribution Workflow

1. Fork the repository on GitHub.

2. Clone your fork locally:

   git clone https://github.com/YOUR_USERNAME/satif.git
   cd satif/libs/sdif
   

3. Create a new branch for your feature or bug fix:

   git checkout -b feature/your-feature-name
   

   or

   git checkout -b fix/your-bug-fix-name
   

4. Set up the development environment as described in the From Source (for Development) section:

   make install  # or poetry install
   

5. Make your changes. Ensure your code follows the project's style guidelines.

6. Format and lint your code:

   make format
   make lint
   

7. Run type checks:

   make typecheck
   

8. Run tests to ensure your changes don't break existing functionality:

   make test
   

   To also generate a coverage report:

   make coverage
   

9. Commit your changes with a clear and descriptive commit message.

10. Push your changes to your fork on GitHub:

    git push origin feature/your-feature-name
    

11. Submit a Pull Request (PR) to the main branch of the original syncpulse-solutions/satif repository.

Coding Standards

• Follow PEP 8 for Python code.
• Use Google Python Style Guide for docstrings (as configured in pyproject.toml).
• Ensure code is well-documented, especially public APIs.

Issue Reporting

• For bug reports, please include steps to reproduce the issue.
• For feature requests, describe the desired functionality and its use case.
• Check existing issues before creating a new one to avoid duplicates.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For questions or support, please open an issue on the GitHub repository.

Maintainer: Bryan Djafer (bryan.djafer@syncpulse.fr)