Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/MujyKun/weverse into main
Browse files Browse the repository at this point in the history
Changed to Classic theme of docs
  • Loading branch information
MujyKun committed May 31, 2021
2 parents 8ba985b + ef9fbe3 commit bd5b4fd
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 3 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# This workflow will upload a Python Package using Twine when a release is created
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries

name: Upload Python Package

on:
release:
types: [created]

jobs:
deploy:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel twine
- name: Build and publish
env:
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
run: |
python setup.py sdist bdist_wheel
twine upload dist/*
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
## Weverse

### What is it?
Weverse creates internal cache for the communities a user follows on [weverse.io](https://www.weverse.io/).
Weverse creates internal cache for the communities a user follows on [weverse.io](https://www.weverse.io/).

### **[API Documentation](https://weverse.readthedocs.io/en/latest/)**

### Functionalities

* Asynchronous and Synchronous Support
* Receive all the posts the artists in your communities have made. This includes all images/videos/comments made by them.
* Cache is split under a hierarchy directly under a community. The most recent is always the first element (0th index).
* Keep track of notifications on your user account, you can easily create a loop to update your notification cache on updates. [**Example of real usage**](https://github.com/MujyKun/IreneBot/blob/9193fcd3b6c73f61c57fb2fad557921141b1c07a/module/Weverse.py#L65)
* Keep track of notifications on your user account, you can easily create a loop to update your notification cache on updates. [**Example of real usage**](https://github.com/MujyKun/IreneBot/blob/5ed92595314e146d0f4a7a3f04461afd168d327f/module/Weverse.py#L80)

### Installation

Expand Down Expand Up @@ -71,4 +73,4 @@ except InvalidToken:

```

## **[API Documentation](https://weverse.readthedocs.io/en/latest/)**
### **[API Documentation](https://weverse.readthedocs.io/en/latest/)**

0 comments on commit bd5b4fd

Please sign in to comment.