Skip to content

Commit

Permalink
Update README.md to indicate maintenance status of project (#20)
Browse files Browse the repository at this point in the history
* Update README.md to indicate maintenance status of project

* Add development branch to test workflow

* Fix typo
  • Loading branch information
JensAstrup authored Dec 28, 2024
1 parent c65d8d6 commit fd376b3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/unit_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ on:
push:
branches:
- main
- development
pull_request:
branches:
- main
- development

jobs:
test:
Expand All @@ -33,4 +35,4 @@ jobs:
- name: Run tests
run: |
pytest --cov=pyOutlook
pytest --cov=pyOutlook
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,13 @@
[![PyPI](https://img.shields.io/pypi/pyversions/pyOutlook.svg?maxAge=2592000)]()
[![Documentation Status](https://readthedocs.org/projects/pyoutlook/badge/?version=latest)](http://pyoutlook.readthedocs.io/en/latest/?badge=latest)

# No longer maintained
This project is no longer maintained, I would recommend either using great caution using this in production applications (as dependencies are likely out of date). If someone is interested enough in having this project continue, feel free to become a sponsor and I'll revive the project. I'm also accepting offers to become a contributor/maintainer on the project (check out my profile for contact methods).

# pyOutlook
A Python module for connecting to the Outlook REST API, without the hassle of dealing with the JSON formatting for requests/responses and the REST endpoints and their varying requirements

The most up to date documentation can be found on [pyOutlook's RTD page](http://pyoutlook.readthedocs.io/en/latest/).
The most up-to-date documentation can be found on [pyOutlook's RTD page](http://pyoutlook.readthedocs.io/en/latest/).

## Instantiation
Before anything can be retrieved or sent, an instance of OutlookAccount must be created.
Before anything can be retrieved or sent, an instance of OutlookAccount must be created.
The only parameter required is the access token for the account.

Note that this module does not handle the OAuth process, gaining an access token must be done outside of this module.
Expand Down Expand Up @@ -52,7 +49,7 @@ print(email.body)
```

### inbox()
This method is identical to get_messages(), however it returns only the ten most recent message in the inbox (ignoring messages that were put into seperate folders by an Outlook rule, junk email, etc)
This method is identical to get_messages(), however it returns only the ten most recent message in the inbox (ignoring messages that were put into separate folders by an Outlook rule, junk email, etc)

```python
from pyOutlook import *
Expand Down

0 comments on commit fd376b3

Please sign in to comment.