Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

merge master #12

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.8"

sphinx:
configuration: docs/conf.py

python:
install:
- requirements: requirements/docs.txt
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
:target: https://coveralls.io/r/ambitioninc/pagerduty-api

.. image:: https://pypip.in/v/pagerduty-api/badge.png
:target: https://crate.io/packages/pagerduty-api/
:target: https://pypi.python.org/pypi/pagerduty-api
:alt: Latest PyPI version

.. image:: https://pypip.in/d/pagerduty-api/badge.png
:target: https://crate.io/packages/pagerduty-api/
:target: https://pypi.python.org/pypi/pagerduty-api
:alt: Number of PyPI downloads


Expand Down
4 changes: 4 additions & 0 deletions docs/release_notes.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
Release Notes
=============

v0.5
----
* Read the docs config v2

v0.3
----
``PAGERDUTY_API_KEY`` is no longer required for the ``Alert()`` object
Expand Down
9 changes: 3 additions & 6 deletions docs/usage.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
Usage
=====

Configuring Alerts
------------------
Alerts has an environment variable will need to configure before using.

Using Alerts
------------
Expand All @@ -19,7 +16,7 @@ unique ID generated in PagerDuty for a Generic API Service.


Trigger Alert
~~~~~~~~~~~~~
-------------
To trigger an alert, use ``.trigger()`` on the interface. If you don't pass in an
incident_key, one will be computed as the md5 hash of the description

Expand All @@ -37,7 +34,7 @@ incident_key, one will be computed as the md5 hash of the description
)

Acknowledge Alert
~~~~~~~~~~~~~~~~~
-----------------
To acknowledge an alert, use ``.acknowledge()`` on the interface. If you created
this alert with ``.trigger()``, you won't need to provide an ``incident_key``.

Expand All @@ -53,7 +50,7 @@ this alert with ``.trigger()``, you won't need to provide an ``incident_key``.
)

Resolve Alert
~~~~~~~~~~~~~
-------------
To resolve an alert, use ``.resolve()`` on the interface. If you created
this alert with ``.trigger()``, you won't need to provide an ``incident_key``.

Expand Down
2 changes: 1 addition & 1 deletion pagerduty_api/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '0.3'
__version__ = '0.5'
6 changes: 6 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
from setuptools import setup, find_packages


import sys
if 'sdist' in sys.argv and sys.version_info < (2, 7, 9, 'final', 0):
import os
del os.link


def get_version():
"""
Extracts the version number from the version.py file.
Expand Down