Merge pull request #19 from yazdipour/bugfix/redef-release-process

chore: refine PyPI deployment workflow and update contributing guidelines

.github/workflows/publish.yml → .github/workflows/release.yml

@@ -1,9 +1,9 @@
-name: 🚀 Deploy to PyPI
+name: 🚀 Releasing new version to PyPI
 
 on:
   push:
     tags:
-      - 'v*'
+      - '*'
 
 permissions:
   contents: read

README.md

@@ -4,8 +4,6 @@
 
 This is a Python client for the [Omnivore API](https://omnivore.app).
 
-[![GitHub stars](https://img.shields.io/github/stars/yazdipour/omnivoreql.svg?style=social&label=Star)](https://github.com/yazdipour/omnivoreql/stargazers)
-[![Github Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/yazdipour)
 
 [![Tests](https://github.com/yazdipour/OmnivoreQL/actions/workflows/test.yml/badge.svg)](https://github.com/yazdipour/OmnivoreQL/actions/workflows/test.yml)
 [![PyPI version](https://badge.fury.io/py/omnivoreql.svg)](https://pypi.org/project/omnivoreql/)
@@ -33,7 +31,8 @@ Use the methods of the OmnivoreQL class to interact with the Omnivore API.
 ```python
 profile = omnivoreql_client.get_profile()
 
-result = omnivoreql_client.save_url("https://www.google.com")
+saved_page = omnivoreql_client.save_url("https://www.google.com")
+saved_page_with_label = omnivoreql_client.save_url("https://www.google.com", ["label1", "label2"])
 
 articles = omnivoreql_client.get_articles()
 
@@ -45,10 +44,18 @@ labels = omnivoreql_client.get_labels()
 subscriptions = omnivoreql_client.get_subscriptions()
 ```
 
-## Contributing
+## Documentation
+
+* Main Omnivore graphql schema is in: [schema.graphql](https://github.com/omnivore-app/omnivore/blob/main/packages/api/src/schema.ts)
+* To contribute to this project: [CONTRIBUTING.md](docs/CONTRIBUTING.md)
+* To more know about Release process: [RELEASE.md](docs/RELEASE.md), [PYPI.md](docs/PYPI.md)
+
+## Support
 
-* If you want to contribute to this project, you can follow steps in [CONTRIBUTING.md](CONTRIBUTING.md) file.
-* Main Omnivore graphql schema is in [schema.graphql](https://github.com/omnivore-app/omnivore/blob/main/packages/api/src/schema.ts) file.
+If you find this project useful, you can support it by becoming a sponsor. Your contribution will help maintain the project and keep it up to date.
+
+[![GitHub stars](https://img.shields.io/github/stars/yazdipour/omnivoreql.svg?style=social&label=Star)](https://github.com/yazdipour/omnivoreql/stargazers)
+[![Github Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/yazdipour)
 
 ## License
 

docs/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing
+
+Thanks for helping to making this project better!
+
+We welcome all kinds of contributions:
+
+- Bug fixes
+- Documentation improvements
+- New features
+- Refactoring & tidying
+
+## Getting started
+
+If you have a specific contribution in mind, be sure to check the **issues and pull requests** in progress - someone could already be working on something similar and you can help out.
+
+## Project setup
+
+### Development with virtualenv
+
+After cloning this repo, create a virtualenv:
+
+```console
+python -m venv .venv
+```
+
+Activate the virtualenv and install dependencies by running:
+
+```console
+python -m pip install -r requirements.txt
+```
+
+### DevContainer
+
+This project includes a `.devcontainer` folder and `devcontainer.json` file to use with Visual Studio Code's Remote - Containers extension. This will set up a development environment with all the necessary tools and dependencies.
+
+## Testing
+

docs/Release.md

@@ -0,0 +1,7 @@
+# Release process
+
+1. Create a new tag with the version number
+2. Push the tag to GitHub
+3. The release will be automatically published to PyPI
+
+You can see how the Github Action for releasing works in the `.github/workflows/release.yml` file.

omnivoreql/omnivoreql.py

@@ -171,7 +171,7 @@ def get_articles(
         self,
         limit: int = None,
         cursor: str = None,
-        format: str = "markdown",
+        format: str = "html",
         query: str = "in:inbox",
         include_content: bool = False,
     ):
@@ -180,7 +180,7 @@ def get_articles(
 
         :param limit: The number of articles to return.
         :param cursor: The cursor to use for pagination.
-        :param format: The format of the articles to return.
+        :param format: The output format of the articles. Can be 'html' (default) or 'markdown'.
         :param query: The query to use for filtering articles. Example of query by date: 'in:inbox published:2024-03-01..*'. See https://docs.omnivore.app/using/search.html#filtering-by-save-publish-dates for more information.
         :param include_content: Whether to include the content of the articles.
         """