bitsidy-sdk


Namebitsidy-sdk JSON
Version 1.0.0 PyPI version JSON
download
home_page
SummaryA Python SDK for Bitsidy API
upload_time2024-02-12 18:51:32
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords
VCS
bugtrack_url
requirements requests cryptography
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Bitsidy Python SDK

Bitsidy SDK is a toolkit for integrating Bitsidy's cryptocurrency invoice services into your Python projects. Whether you are using npm for dependency management or prefer manual inclusion, this SDK is designed for easy integration.

## Project Structure

- `bitsidy_sdk/sdk.py`: The core SDK file.
- `examples/example.py`: An example script demonstrating SDK usage.
- `examples/callback.py`: An example script demonstrating how to handle received callback data.
- `pyproject.toml`: The configuration file for packaging tools.

## Requirements

The dependencies are specified in the __requirements.txt__ file. To install them manually, run:

```bash
pip install -r requirements.txt
```

To run the `examples/callback.py` example script, which demonstrates handling callback data, the following specific requirements must be met:

```bash
pip install flask
```

## Installation

### Using PyPi

To install via PyPi, run:

```bash
pip install bitsidy-sdk
```

Then, require the SDK in your script:

```python
from bitsidy_sdk import BitsidySDK
```

### Manual Installation

1. Download or clone the Bitsidy SDK repository.
2. Place the SDK folder in your project directory.
3. In your Python file, use require to include the SDK. Assuming the SDK folder is named bitsidy_sdk and it's placed in your project's root directory, the code to include it would be:

```python
from src.bitsidy_sdk import BitsidySDK
```

## Usage

Refer to examples/example.py for a practical demonstration on using the Bitsidy SDK to create invoices and handle responses. For understanding how our server communicates invoice status updates, consult examples/callback.py.

## Contributing

Contributions to the Bitsidy SDK are welcome. Please ensure that your code adheres to the project's coding standards and include tests for new features or bug fixes.

## License

This project is licensed under the GPLv3.

For more information and updates, visit the project repository.
            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "bitsidy-sdk",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "Bitsidy <support@bitsidy.com>",
    "download_url": "https://files.pythonhosted.org/packages/1e/db/df06505bf60c428a5d366e6468efc5f02225120250a8a0bc536e8d519c8d/bitsidy_sdk-1.0.0.tar.gz",
    "platform": null,
    "description": "# Bitsidy Python SDK\n\nBitsidy SDK is a toolkit for integrating Bitsidy's cryptocurrency invoice services into your Python projects. Whether you are using npm for dependency management or prefer manual inclusion, this SDK is designed for easy integration.\n\n## Project Structure\n\n- `bitsidy_sdk/sdk.py`: The core SDK file.\n- `examples/example.py`: An example script demonstrating SDK usage.\n- `examples/callback.py`: An example script demonstrating how to handle received callback data.\n- `pyproject.toml`: The configuration file for packaging tools.\n\n## Requirements\n\nThe dependencies are specified in the __requirements.txt__ file. To install them manually, run:\n\n```bash\npip install -r requirements.txt\n```\n\nTo run the `examples/callback.py` example script, which demonstrates handling callback data, the following specific requirements must be met:\n\n```bash\npip install flask\n```\n\n## Installation\n\n### Using PyPi\n\nTo install via PyPi, run:\n\n```bash\npip install bitsidy-sdk\n```\n\nThen, require the SDK in your script:\n\n```python\nfrom bitsidy_sdk import BitsidySDK\n```\n\n### Manual Installation\n\n1. Download or clone the Bitsidy SDK repository.\n2. Place the SDK folder in your project directory.\n3. In your Python file, use require to include the SDK. Assuming the SDK folder is named bitsidy_sdk and it's placed in your project's root directory, the code to include it would be:\n\n```python\nfrom src.bitsidy_sdk import BitsidySDK\n```\n\n## Usage\n\nRefer to examples/example.py for a practical demonstration on using the Bitsidy SDK to create invoices and handle responses. For understanding how our server communicates invoice status updates, consult examples/callback.py.\n\n## Contributing\n\nContributions to the Bitsidy SDK are welcome. Please ensure that your code adheres to the project's coding standards and include tests for new features or bug fixes.\n\n## License\n\nThis project is licensed under the GPLv3.\n\nFor more information and updates, visit the project repository.",
    "bugtrack_url": null,
    "license": "",
    "summary": "A Python SDK for Bitsidy API",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://github.com/bitsidy-com/bitsidy-python-sdk",
        "Issues": "https://github.com/bitsidy-com/bitsidy-python-sdk/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "060cd627a4a90d99a248535aa52e5e852bcfbb8e7e21e3b31e1928171410d16b",
                "md5": "2320d969d3eb3dada55f22d09db14d8b",
                "sha256": "6563b92c5bbc311468c98e822e8fdb0a95c90d71048b4c7f6a96acb7a4a7af41"
            },
            "downloads": -1,
            "filename": "bitsidy_sdk-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2320d969d3eb3dada55f22d09db14d8b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 15407,
            "upload_time": "2024-02-12T18:51:29",
            "upload_time_iso_8601": "2024-02-12T18:51:29.759663Z",
            "url": "https://files.pythonhosted.org/packages/06/0c/d627a4a90d99a248535aa52e5e852bcfbb8e7e21e3b31e1928171410d16b/bitsidy_sdk-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1edbdf06505bf60c428a5d366e6468efc5f02225120250a8a0bc536e8d519c8d",
                "md5": "71a14105767705b45314f39bd6e026d9",
                "sha256": "6ceb280a556feab2cbfd687d1623809926c106307180a87fcda5b404d997a4e0"
            },
            "downloads": -1,
            "filename": "bitsidy_sdk-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "71a14105767705b45314f39bd6e026d9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 15918,
            "upload_time": "2024-02-12T18:51:32",
            "upload_time_iso_8601": "2024-02-12T18:51:32.833189Z",
            "url": "https://files.pythonhosted.org/packages/1e/db/df06505bf60c428a5d366e6468efc5f02225120250a8a0bc536e8d519c8d/bitsidy_sdk-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-12 18:51:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bitsidy-com",
    "github_project": "bitsidy-python-sdk",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "requests",
            "specs": [
                [
                    "~=",
                    "2.31.0"
                ]
            ]
        },
        {
            "name": "cryptography",
            "specs": [
                [
                    "~=",
                    "42.0.2"
                ]
            ]
        }
    ],
    "lcname": "bitsidy-sdk"
}
        
Elapsed time: 0.23115s