# CscTrackerQueueScheduler
This project is a Python job scheduling and queuing library. It allows jobs to be scheduled to run at specific periods
and queues these jobs for execution.
## Key Features
- **Job Scheduling**: The Scheduler service (`SchedulerService`) allows jobs to be scheduled for execution at specified
intervals. It supports intervals in seconds, minutes, hours, days, and weeks, as well as daily scheduling at a
specific time.
- **Queue Service**: Scheduled tasks are put in a queue (`QueueService`) for execution. Tasks can be queued with or
without priority, which determines their order of execution.
## Installing
Install and update using pip:
```
pip install csctracker-queue-scheduler
```
## Documentation and Examples
COMING SOON
## Simple Example
```python
from csctracker_queue_scheduler.models.enums.time_unit import TimeUnit
from csctracker_queue_scheduler.services.scheduler_service import SchedulerService
def my_function(): print("Hello, world!")
SchedulerService.start_scheduled_job(
function=my_function, period=5, time_unit=TimeUnit.SECONDS)
```
In the above example, `my_function` would be scheduled to run every 5 minutes.
## Testing
Currently, this project does not have automated tests. They may be added in the future as needed.
## Contributing
If you would like to contribute to this project, feel free to fork the repository, make your changes, and propose a pull
request.
## License
This project is under the MIT license. Please refer to the `LICENSE` file for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/krlsedu/CscTrackerQueueScheduler.git",
"name": "csctracker-queue-scheduler",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "queue,scheduled,scheduler",
"author": "Carlos Eduardo",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/91/9c/f8f91bfa3eab4e4d26de28b898cbfeb1723f26ef90563641f5362b2dcf57/csctracker-queue-scheduler-24.6.1.tar.gz",
"platform": null,
"description": "# CscTrackerQueueScheduler\n\nThis project is a Python job scheduling and queuing library. It allows jobs to be scheduled to run at specific periods\nand queues these jobs for execution.\n\n## Key Features\n\n- **Job Scheduling**: The Scheduler service (`SchedulerService`) allows jobs to be scheduled for execution at specified\n intervals. It supports intervals in seconds, minutes, hours, days, and weeks, as well as daily scheduling at a\n specific time.\n\n- **Queue Service**: Scheduled tasks are put in a queue (`QueueService`) for execution. Tasks can be queued with or\n without priority, which determines their order of execution.\n\n## Installing\n\nInstall and update using pip:\n\n```\npip install csctracker-queue-scheduler\n```\n\n## Documentation and Examples\n\nCOMING SOON\n\n## Simple Example\n\n```python \nfrom csctracker_queue_scheduler.models.enums.time_unit import TimeUnit\nfrom csctracker_queue_scheduler.services.scheduler_service import SchedulerService\n\n\ndef my_function(): print(\"Hello, world!\")\n\n\nSchedulerService.start_scheduled_job(\n function=my_function, period=5, time_unit=TimeUnit.SECONDS)\n```\n\nIn the above example, `my_function` would be scheduled to run every 5 minutes.\n\n## Testing\n\nCurrently, this project does not have automated tests. They may be added in the future as needed.\n\n## Contributing\n\nIf you would like to contribute to this project, feel free to fork the repository, make your changes, and propose a pull\nrequest.\n\n## License\n\nThis project is under the MIT license. Please refer to the `LICENSE` file for more details.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library for handle scheduled jobs.",
"version": "24.6.1",
"project_urls": {
"Homepage": "https://github.com/krlsedu/CscTrackerQueueScheduler.git"
},
"split_keywords": [
"queue",
"scheduled",
"scheduler"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa0f7a71b1257fc5d6f518a43fac2062112ee0d5409233eebea41843fb72d8ac",
"md5": "bdb4fd71b4790bf89a7d6e7ed3e57259",
"sha256": "9ab32b0d47972f59d7250585a8bb690364c78a57b678ce3ae78625b838dc83c2"
},
"downloads": -1,
"filename": "csctracker_queue_scheduler-24.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bdb4fd71b4790bf89a7d6e7ed3e57259",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 8674,
"upload_time": "2024-02-04T15:45:53",
"upload_time_iso_8601": "2024-02-04T15:45:53.433949Z",
"url": "https://files.pythonhosted.org/packages/fa/0f/7a71b1257fc5d6f518a43fac2062112ee0d5409233eebea41843fb72d8ac/csctracker_queue_scheduler-24.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "919cf8f91bfa3eab4e4d26de28b898cbfeb1723f26ef90563641f5362b2dcf57",
"md5": "dfe21565f09d017cc71eb126dd54d662",
"sha256": "f6ae2bba1f049ec4029eb8d122678583808428ac840dcae7b443a793331d86f3"
},
"downloads": -1,
"filename": "csctracker-queue-scheduler-24.6.1.tar.gz",
"has_sig": false,
"md5_digest": "dfe21565f09d017cc71eb126dd54d662",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 7132,
"upload_time": "2024-02-04T15:45:54",
"upload_time_iso_8601": "2024-02-04T15:45:54.797346Z",
"url": "https://files.pythonhosted.org/packages/91/9c/f8f91bfa3eab4e4d26de28b898cbfeb1723f26ef90563641f5362b2dcf57/csctracker-queue-scheduler-24.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-04 15:45:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "krlsedu",
"github_project": "CscTrackerQueueScheduler",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pytz",
"specs": [
[
"~=",
"2023.3.post1"
]
]
},
{
"name": "schedule",
"specs": [
[
"~=",
"1.2.1"
]
]
}
],
"lcname": "csctracker-queue-scheduler"
}
JSON
