chromastone

Name	chromastone JSON
Version	0.2.6 JSON
	download
home_page	https://github.com/lordskyzw/chromastone
Summary	A Python application for powering other python applications to send SMS messages globally with number validation and restrictions by Tarmica Chiwara
upload_time	2024-04-14 17:29:34
maintainer	None
docs_url	None
author	Tarmica Chiwara
requires_python	>=3.9
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            
# Chromastone SMS App

Chromastone is a Python application designed to simplify the process of sending SMS messages. Utilizing a straightforward API, Chromastone ensures that destination numbers are validated and messages are efficiently delivered while adhering to specified constraints.

## Features

- Validation of destination numbers to ensure they are in international format without the '+' prefix.
- Enforcement of message length to not exceed 100 characters.
- Easy integration with existing Python applications.

## Installation

To use Chromastone, you need to install the required dependencies first. It is recommended to use a virtual environment:

```bash
python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`
```

After activating the virtual environment, install the dependencies:

```bash
pip install requests pydantic
```

## Configuration

Before you can start sending SMS messages, ensure you have an API key from the SMS service provider. You will need to replace 'your_api_key_here' in the code with your actual API key.

## Usage

To send an SMS using Chromastone, instantiate the `Chromastone` class with your API key and call the `send_sms` method with the source number, destination number, and message:

```python
from chromastone import Chromastone

chromastone = Chromastone(api_key='your_api_key_here')
chromastone.send_sms(source_number='1234567890', destination_number='263771123456', message='Hello, world!')
```

Ensure the destination number is in the correct format and the message does not exceed 100 characters.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contributions

Contributions are welcome! Please feel free to submit a pull request or open an issue for any bugs or feature requests.

## Acknowledgments

- Thanks to the Pydantic library for providing robust data validation.
- Gratitude to the Requests library for simplifying HTTP requests in Python.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/lordskyzw/chromastone",
    "name": "chromastone",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Tarmica Chiwara",
    "author_email": "lilskyforever@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/fd/80/fde3ec1bc91f8ed6e15880b821f02ceeb6b2b3cd3256eb6972ae76f79a77/chromastone-0.2.6.tar.gz",
    "platform": null,
    "description": "\n# Chromastone SMS App\n\nChromastone is a Python application designed to simplify the process of sending SMS messages. Utilizing a straightforward API, Chromastone ensures that destination numbers are validated and messages are efficiently delivered while adhering to specified constraints.\n\n## Features\n\n- Validation of destination numbers to ensure they are in international format without the '+' prefix.\n- Enforcement of message length to not exceed 100 characters.\n- Easy integration with existing Python applications.\n\n## Installation\n\nTo use Chromastone, you need to install the required dependencies first. It is recommended to use a virtual environment:\n\n```bash\npython -m venv venv\nsource venv/bin/activate  # On Windows use `venv\\Scripts\\activate`\n```\n\nAfter activating the virtual environment, install the dependencies:\n\n```bash\npip install requests pydantic\n```\n\n## Configuration\n\nBefore you can start sending SMS messages, ensure you have an API key from the SMS service provider. You will need to replace 'your_api_key_here' in the code with your actual API key.\n\n## Usage\n\nTo send an SMS using Chromastone, instantiate the `Chromastone` class with your API key and call the `send_sms` method with the source number, destination number, and message:\n\n```python\nfrom chromastone import Chromastone\n\nchromastone = Chromastone(api_key='your_api_key_here')\nchromastone.send_sms(source_number='1234567890', destination_number='263771123456', message='Hello, world!')\n```\n\nEnsure the destination number is in the correct format and the message does not exceed 100 characters.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Contributions\n\nContributions are welcome! Please feel free to submit a pull request or open an issue for any bugs or feature requests.\n\n## Acknowledgments\n\n- Thanks to the Pydantic library for providing robust data validation.\n- Gratitude to the Requests library for simplifying HTTP requests in Python.\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python application for powering other python applications to send SMS messages globally with number validation and restrictions by Tarmica Chiwara",
    "version": "0.2.6",
    "project_urls": {
        "Homepage": "https://github.com/lordskyzw/chromastone"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a9ae672648d99f452f74ab73e6b553609257f9098c855e86f1566cfd2e52fcef",
                "md5": "09fb3b66d43b9f0dd7f7174f6d7fe5ca",
                "sha256": "51621f07867027451453291215cb859755402d1619b3a56b9e2af538578c9fa0"
            },
            "downloads": -1,
            "filename": "chromastone-0.2.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "09fb3b66d43b9f0dd7f7174f6d7fe5ca",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 5978,
            "upload_time": "2024-04-14T17:29:33",
            "upload_time_iso_8601": "2024-04-14T17:29:33.103961Z",
            "url": "https://files.pythonhosted.org/packages/a9/ae/672648d99f452f74ab73e6b553609257f9098c855e86f1566cfd2e52fcef/chromastone-0.2.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fd80fde3ec1bc91f8ed6e15880b821f02ceeb6b2b3cd3256eb6972ae76f79a77",
                "md5": "489faff29bb13d8fed216082107c51bd",
                "sha256": "8de2cce1c363136163241c4de5a7accfb0f4eba4d9220d42f66c727488176aaa"
            },
            "downloads": -1,
            "filename": "chromastone-0.2.6.tar.gz",
            "has_sig": false,
            "md5_digest": "489faff29bb13d8fed216082107c51bd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 4244,
            "upload_time": "2024-04-14T17:29:34",
            "upload_time_iso_8601": "2024-04-14T17:29:34.827463Z",
            "url": "https://files.pythonhosted.org/packages/fd/80/fde3ec1bc91f8ed6e15880b821f02ceeb6b2b3cd3256eb6972ae76f79a77/chromastone-0.2.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-14 17:29:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "lordskyzw",
    "github_project": "chromastone",
    "github_not_found": true,
    "lcname": "chromastone"
}