Python Client for Cloud Scheduler
=================================
|stable| |pypi| |versions|
`Cloud Scheduler`_: lets you set up scheduled units of work to be executed at defined times or regular intervals. These work units are commonly known as cron jobs. Typical use cases might include sending out a report email on a daily basis, updating some cached data every 10 minutes, or updating some summary information once an hour.
- `Client Library Documentation`_
- `Product Documentation`_
.. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-scheduler.svg
:target: https://pypi.org/project/google-cloud-scheduler/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-scheduler.svg
:target: https://pypi.org/project/google-cloud-scheduler/
.. _Cloud Scheduler: https://cloud.google.com/scheduler/docs
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/cloudscheduler/latest/summary_overview
.. _Product Documentation: https://cloud.google.com/scheduler/docs
Quick Start
-----------
In order to use this library, you first need to go through the following steps:
1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. `Enable the Cloud Scheduler.`_
4. `Setup Authentication.`_
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Cloud Scheduler.: https://cloud.google.com/scheduler/docs
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
Installation
~~~~~~~~~~~~
Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
creates isolated Python environments. These isolated environments can have separate
versions of Python packages, which allows you to isolate one project's dependencies
from the dependencies of other projects.
With `venv`_, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.
.. _`venv`: https://docs.python.org/3/library/venv.html
Code samples and snippets
~~~~~~~~~~~~~~~~~~~~~~~~~
Code samples and snippets live in the `samples/`_ folder.
.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-scheduler/samples
Supported Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^
Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
Python.
Python >= 3.7
.. _active: https://devguide.python.org/devcycle/#in-development-main-branch
.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
Unsupported Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Python <= 3.6
If you are using an `end-of-life`_
version of Python, we recommend that you update as soon as possible to an actively supported version.
.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches
Mac/Linux
^^^^^^^^^
.. code-block:: console
python3 -m venv <your-env>
source <your-env>/bin/activate
pip install google-cloud-scheduler
Windows
^^^^^^^
.. code-block:: console
py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-scheduler
Next Steps
~~~~~~~~~~
- Read the `Client Library Documentation`_ for Cloud Scheduler
to see other available methods on the client.
- Read the `Cloud Scheduler Product documentation`_ to learn
more about the product and see How-to Guides.
- View this `README`_ to see the full list of Cloud
APIs that we cover.
.. _Cloud Scheduler Product documentation: https://cloud.google.com/scheduler/docs
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
Raw data
{
"_id": null,
"home_page": "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-scheduler",
"name": "google-cloud-scheduler",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Google LLC",
"author_email": "googleapis-packages@google.com",
"download_url": "https://files.pythonhosted.org/packages/e6/26/73fd14a614a431d96beaa25d1c74a3d9c15a93fc287843a334129248336c/google_cloud_scheduler-2.13.5.tar.gz",
"platform": "Posix; MacOS X; Windows",
"description": "Python Client for Cloud Scheduler\n=================================\n\n|stable| |pypi| |versions|\n\n`Cloud Scheduler`_: lets you set up scheduled units of work to be executed at defined times or regular intervals. These work units are commonly known as cron jobs. Typical use cases might include sending out a report email on a daily basis, updating some cached data every 10 minutes, or updating some summary information once an hour.\n\n- `Client Library Documentation`_\n- `Product Documentation`_\n\n.. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg\n :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels\n.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-scheduler.svg\n :target: https://pypi.org/project/google-cloud-scheduler/\n.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-scheduler.svg\n :target: https://pypi.org/project/google-cloud-scheduler/\n.. _Cloud Scheduler: https://cloud.google.com/scheduler/docs\n.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/cloudscheduler/latest/summary_overview\n.. _Product Documentation: https://cloud.google.com/scheduler/docs\n\nQuick Start\n-----------\n\nIn order to use this library, you first need to go through the following steps:\n\n1. `Select or create a Cloud Platform project.`_\n2. `Enable billing for your project.`_\n3. `Enable the Cloud Scheduler.`_\n4. `Setup Authentication.`_\n\n.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project\n.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project\n.. _Enable the Cloud Scheduler.: https://cloud.google.com/scheduler/docs\n.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html\n\nInstallation\n~~~~~~~~~~~~\n\nInstall this library in a virtual environment using `venv`_. `venv`_ is a tool that\ncreates isolated Python environments. These isolated environments can have separate\nversions of Python packages, which allows you to isolate one project's dependencies\nfrom the dependencies of other projects.\n\nWith `venv`_, it's possible to install this library without needing system\ninstall permissions, and without clashing with the installed system\ndependencies.\n\n.. _`venv`: https://docs.python.org/3/library/venv.html\n\n\nCode samples and snippets\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nCode samples and snippets live in the `samples/`_ folder.\n\n.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-scheduler/samples\n\n\nSupported Python Versions\n^^^^^^^^^^^^^^^^^^^^^^^^^\nOur client libraries are compatible with all current `active`_ and `maintenance`_ versions of\nPython.\n\nPython >= 3.7\n\n.. _active: https://devguide.python.org/devcycle/#in-development-main-branch\n.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches\n\nUnsupported Python Versions\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\nPython <= 3.6\n\nIf you are using an `end-of-life`_\nversion of Python, we recommend that you update as soon as possible to an actively supported version.\n\n.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches\n\nMac/Linux\n^^^^^^^^^\n\n.. code-block:: console\n\n python3 -m venv <your-env>\n source <your-env>/bin/activate\n pip install google-cloud-scheduler\n\n\nWindows\n^^^^^^^\n\n.. code-block:: console\n\n py -m venv <your-env>\n .\\<your-env>\\Scripts\\activate\n pip install google-cloud-scheduler\n\nNext Steps\n~~~~~~~~~~\n\n- Read the `Client Library Documentation`_ for Cloud Scheduler\n to see other available methods on the client.\n- Read the `Cloud Scheduler Product documentation`_ to learn\n more about the product and see How-to Guides.\n- View this `README`_ to see the full list of Cloud\n APIs that we cover.\n\n.. _Cloud Scheduler Product documentation: https://cloud.google.com/scheduler/docs\n.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Google Cloud Scheduler API client library",
"version": "2.13.5",
"project_urls": {
"Homepage": "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-scheduler"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9765c84a4a2445dd006cebbf505c82f34d44fe3afc4d19fb87fd88a489b70c4c",
"md5": "8d19b63339c8223e1bbda6e9fdd77690",
"sha256": "3c385f7cdeed283e170ee58db25d8a942acab93298958d854019c2dc368b8f1a"
},
"downloads": -1,
"filename": "google_cloud_scheduler-2.13.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "8d19b63339c8223e1bbda6e9fdd77690",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 117524,
"upload_time": "2024-07-30T21:27:37",
"upload_time_iso_8601": "2024-07-30T21:27:37.924553Z",
"url": "https://files.pythonhosted.org/packages/97/65/c84a4a2445dd006cebbf505c82f34d44fe3afc4d19fb87fd88a489b70c4c/google_cloud_scheduler-2.13.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e62673fd14a614a431d96beaa25d1c74a3d9c15a93fc287843a334129248336c",
"md5": "1bfe02acddfc12bcd5634eab08ea0063",
"sha256": "3f91ce3b2c98834036cc68ad23aa987df9fe2176e9d47e32484c01d301e37b81"
},
"downloads": -1,
"filename": "google_cloud_scheduler-2.13.5.tar.gz",
"has_sig": false,
"md5_digest": "1bfe02acddfc12bcd5634eab08ea0063",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 128426,
"upload_time": "2024-07-30T21:27:39",
"upload_time_iso_8601": "2024-07-30T21:27:39.439190Z",
"url": "https://files.pythonhosted.org/packages/e6/26/73fd14a614a431d96beaa25d1c74a3d9c15a93fc287843a334129248336c/google_cloud_scheduler-2.13.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-30 21:27:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "googleapis",
"github_project": "google-cloud-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "google-cloud-scheduler"
}
JSON
