oncall


Nameoncall JSON
Version 2.1.7 PyPI version JSON
download
home_pagehttps://github.com/linkedin/oncall
SummaryOncall is a calendar tool designed for scheduling and managing on-call shifts
upload_time2024-03-12 20:58:04
maintainer
docs_urlNone
author
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Oncall [![Gitter chat](https://badges.gitter.im/irisoncall/Lobby.png)](https://gitter.im/irisoncall/Lobby) [![Build Status](https://circleci.com/gh/linkedin/oncall.svg?style=shield)](https://circleci.com/gh/linkedin/oncall)
======

<p align="center"><img src="https://github.com/linkedin/oncall/raw/master/docs/source/_static/demo.png" width="600"></p>

See [admin docs](http://oncall.tools/docs/admin_guide.html) for information on
how to run and manage Oncall.

Development setup
-----------------

### Local machine

<details> 
  <summary>See instructions for setting up Oncall on your local machine</summary>

### Prerequisites

  * Debian/Ubuntu - `sudo apt-get install libsasl2-dev python3-dev libldap2-dev libssl-dev python-pip python-setuptools mysql-server mysql-client`

### Install

```bash
python setup.py develop
pip install -e '.[dev]'
```

Setup mysql schema:

```bash
mysql -u root -p < ./db/schema.v0.sql
```

Setup app config by editing configs/config.yaml.

Optionally, you can import dummy data for testing:

```bash
mysql -u root -p -o oncall < ./db/dummy_data.sql
```

### Run

One of the following commands:

* `goreman start`
* `procman start`
* `make serve`
* `oncall-dev ./configs/config.yaml`


### Test

```bash
make test
```
</details>

### Docker compose

<details> 
  <summary>See instructions for using <code>docker compose</code></summary>

### Running

```bash
make compose
```

or running `docker compose` directly:

```bash
docker compose up --build
```

### Limitations

* Doesn't currently provide a mechanism for running tests
* Requires rebuilding to apply code changes
* Doesn't tail Python logs to stdout

</details>

## Contributing

Check out https://github.com/linkedin/oncall/issues for a list of outstanding
issues, and tackle any one that catches your interest. Contributions are
expected to be tested thoroughly and submitted with unit/end-to-end tests; look
in the e2e directory for our suite of end-to-end tests.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/linkedin/oncall",
    "name": "oncall",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/a4/fb/dd59d1955c27a0fcf55734e4314948665379f5344c8009be53d9d8ea43bf/oncall-2.1.7.tar.gz",
    "platform": null,
    "description": "Oncall [![Gitter chat](https://badges.gitter.im/irisoncall/Lobby.png)](https://gitter.im/irisoncall/Lobby) [![Build Status](https://circleci.com/gh/linkedin/oncall.svg?style=shield)](https://circleci.com/gh/linkedin/oncall)\n======\n\n<p align=\"center\"><img src=\"https://github.com/linkedin/oncall/raw/master/docs/source/_static/demo.png\" width=\"600\"></p>\n\nSee [admin docs](http://oncall.tools/docs/admin_guide.html) for information on\nhow to run and manage Oncall.\n\nDevelopment setup\n-----------------\n\n### Local machine\n\n<details> \n  <summary>See instructions for setting up Oncall on your local machine</summary>\n\n### Prerequisites\n\n  * Debian/Ubuntu - `sudo apt-get install libsasl2-dev python3-dev libldap2-dev libssl-dev python-pip python-setuptools mysql-server mysql-client`\n\n### Install\n\n```bash\npython setup.py develop\npip install -e '.[dev]'\n```\n\nSetup mysql schema:\n\n```bash\nmysql -u root -p < ./db/schema.v0.sql\n```\n\nSetup app config by editing configs/config.yaml.\n\nOptionally, you can import dummy data for testing:\n\n```bash\nmysql -u root -p -o oncall < ./db/dummy_data.sql\n```\n\n### Run\n\nOne of the following commands:\n\n* `goreman start`\n* `procman start`\n* `make serve`\n* `oncall-dev ./configs/config.yaml`\n\n\n### Test\n\n```bash\nmake test\n```\n</details>\n\n### Docker compose\n\n<details> \n  <summary>See instructions for using <code>docker compose</code></summary>\n\n### Running\n\n```bash\nmake compose\n```\n\nor running `docker compose` directly:\n\n```bash\ndocker compose up --build\n```\n\n### Limitations\n\n* Doesn't currently provide a mechanism for running tests\n* Requires rebuilding to apply code changes\n* Doesn't tail Python logs to stdout\n\n</details>\n\n## Contributing\n\nCheck out https://github.com/linkedin/oncall/issues for a list of outstanding\nissues, and tackle any one that catches your interest. Contributions are\nexpected to be tested thoroughly and submitted with unit/end-to-end tests; look\nin the e2e directory for our suite of end-to-end tests.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Oncall is a calendar tool designed for scheduling and managing on-call shifts",
    "version": "2.1.7",
    "project_urls": {
        "Homepage": "https://github.com/linkedin/oncall"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7f1da7a62ab1c619bb260e09a777b920519370c339e14b6707df64ba6a36f6a3",
                "md5": "cba3c21648195ed8fc978723b8ec5c35",
                "sha256": "773a3d884b229c745bfa2cf4e60fc5a42931790e4d8db91f8605991d2b89ed7d"
            },
            "downloads": -1,
            "filename": "oncall-2.1.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cba3c21648195ed8fc978723b8ec5c35",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 644420,
            "upload_time": "2024-03-12T20:58:01",
            "upload_time_iso_8601": "2024-03-12T20:58:01.389871Z",
            "url": "https://files.pythonhosted.org/packages/7f/1d/a7a62ab1c619bb260e09a777b920519370c339e14b6707df64ba6a36f6a3/oncall-2.1.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a4fbdd59d1955c27a0fcf55734e4314948665379f5344c8009be53d9d8ea43bf",
                "md5": "9984c13621910e8b7d8007b307c5d2e1",
                "sha256": "a78686317eb77e3c4d92b09fce6274535fb7d4f5566a697eba7d828146c93bd9"
            },
            "downloads": -1,
            "filename": "oncall-2.1.7.tar.gz",
            "has_sig": false,
            "md5_digest": "9984c13621910e8b7d8007b307c5d2e1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 581831,
            "upload_time": "2024-03-12T20:58:04",
            "upload_time_iso_8601": "2024-03-12T20:58:04.379744Z",
            "url": "https://files.pythonhosted.org/packages/a4/fb/dd59d1955c27a0fcf55734e4314948665379f5344c8009be53d9d8ea43bf/oncall-2.1.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-12 20:58:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "linkedin",
    "github_project": "oncall",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "circle": true,
    "tox": true,
    "lcname": "oncall"
}
        
Elapsed time: 0.19330s