Merge branch 'feature/venv'
# Conflicts: # .github/workflows/tests.yml # README.md # inkycal/modules/ical_parser.py # inkycal/modules/inkycal_agenda.py # inkycal/modules/inkycal_feeds.py # inkycal/modules/inkycal_todoist.py # inkycal/modules/inkycal_weather.py # requirements.txt
This commit is contained in:
aceisace
28
.github/CONTRIBUTING.md
vendored
28
.github/CONTRIBUTING.md
vendored
@@ -1,25 +1,31 @@
|
||||
# Contribution Policy the E-Paper Calendar software
|
||||
# Inkycal Contribution Policy
|
||||
|
||||
Thanks for contributing to the E-Paper Calendar Software!
|
||||
Thanks for willing to contribute to Inkycal
|
||||
We welcome all sort of contributions, for example:
|
||||
* giving support via the Discord server
|
||||
* submitting hotfixes for existing bugs
|
||||
* giving ideas for new features
|
||||
* financial contributions (while Inkycal is still dependent on them. These go towards new hardware, displays and a bit of coffee)
|
||||
|
||||
If you wish to contribute, please test your suggestion for at least one week on your own E-Paper first. Often, a small change makes a lot
|
||||
of difference so it's important to check how well your suggestion can perform.
|
||||
# Third party modules
|
||||
So you had a great idea for an inkycal-module? Awesome! In fact, there is already a repo sepcfifically created for that purpose: [inkycal-modules-template](https://github.com/aceisace/inkycal-modules-template). Just fork that repo, add your module and give me a shout via Discord, Github or Email. If it is really unique and convincing, chances are, if you agree, that it will be available as default module in a future release. Please do not attempt to have it merged straight into main. We try not to touch main except for new releases to keep things consistent, stable and easy-to-maintain.
|
||||
|
||||
# Code contributions
|
||||
# Code contributions (PRs, hotfixes, Critical improvements)
|
||||
So you found a bug in Inkycal and tested out a bugfix? Kudos! Please fork the Inkycal repo, add your changes in there and create a PR targeting main. For all other PRs, please target a different branch.
|
||||
|
||||
Code contrubutions are most welcome. If you want to contrubite, please fork the main repo, apply changes to your own branch or a new one, test it for at least one week (see above) and then submit a Pull Request. Lastly, don't forget to add your name to the file `CONTRIBUTORS.md`. Thank You!
|
||||
Don't forget to add your name in the file `CONTRIBUTORS.md` of the corresponding branch. Thank You!
|
||||
|
||||
# Submitting Issues
|
||||
|
||||
Please only submit reproducible issues and write the instructions on how to reproduce them.
|
||||
Please only submit reproducible issues with clear instructions on how to reproduce them.
|
||||
|
||||
When you are submitting a new issue, please supply the following information:
|
||||
|
||||
### Release version
|
||||
* are you using main or a different branch. In most cases, this is main
|
||||
|
||||
### Expected behavior
|
||||
|
||||
### Actual behavior
|
||||
### Expected behavior and actual behavior
|
||||
* what were you expecting to happen and what did really happen?
|
||||
|
||||
### Steps to reproduce the behavior
|
||||
|
||||
* How can the devs re-create the same problem you were having?
|
||||
|
||||
27
.github/CONTRIBUTORS.md
vendored
27
.github/CONTRIBUTORS.md
vendored
@@ -39,7 +39,26 @@ The following people have voluteered to test the beta release (pre-release). Tha
|
||||
## Financial Contributions
|
||||
| Name | Contribution details |
|
||||
| --- | --- |
|
||||
| **Kevin** | A special thank you for contribution! :tada: |
|
||||
| **Eric** | A special thank you for contribution! :tada: |
|
||||
| **Thomas** | A special thank you for contribution! :tada: |
|
||||
| **Marcel Schumann** | A special thank you for contribution! :tada: |
|
||||
| **Kevin** | A special thank you for your contribution! :tada: |
|
||||
| **Eric** | A special thank you for your contribution! :tada: |
|
||||
| **Thomas** | A special thank you for your contribution! :tada: |
|
||||
| **Marcel S.** | A special thank you for your contribution! :tada: |
|
||||
| **Markus M.** | A special thank you for your contribution! :tada: |
|
||||
| **Lara** | A special thank you for your contribution! :tada: |
|
||||
| **Richard** | A special thank you for your contribution! :tada: |
|
||||
| **[David S.](https://github.com/piimp)** | A special thank you for your contribution! :tada: |
|
||||
| **Rene N** | A special thank you for your contribution! :tada: |
|
||||
| **Koorathota** | A special thank you for your contribution! :tada: |
|
||||
| **Christopher C.** | A special thank you for your contribution! :tada: |
|
||||
| **Stefan A.** | A special thank you for your contribution! :tada: |
|
||||
| **Florian B.** | A special thank you for your contribution! :tada: |
|
||||
| **Achint M.** | A special thank you for your contribution! :tada: |
|
||||
| **Felix J.** | A special thank you for your contribution! :tada: |
|
||||
| **Michael W.** | A special thank you for your contribution! :tada: |
|
||||
| **Dennis R.** | A special thank you for your contribution! :tada: |
|
||||
| **Max G.** | A special thank you for your contribution! :tada: |
|
||||
| **Sun L.** | A special thank you for your contribution! :tada: |
|
||||
| **Martin K.** | A special thank you for your contribution! :tada: |
|
||||
| **Simon K.** | A special thank you for your contribution! :tada: |
|
||||
| **Roman F.** | A special thank you for your contribution! :tada: |
|
||||
| **Lars L.**| A special thank you for your contribution! :tada: |
|
||||
|
||||
3
.github/FUNDING.yml
vendored
3
.github/FUNDING.yml
vendored
@@ -5,8 +5,7 @@ patreon: # Replace with a single Patreon username
|
||||
open_collective: # Replace with a single Open Collective username
|
||||
ko_fi: # Replace with a single Ko-fi username
|
||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||
community_bridge: inky-calendar
|
||||
liberapay: # Replace with a single Liberapay username
|
||||
issuehunt: # Replace with a single IssueHunt username
|
||||
otechie: # Replace with a single Otechie username
|
||||
custom: ['https://www.paypal.me/SaadNaseer']
|
||||
custom: ['https://www.paypal.me/Aceinnolab']
|
||||
|
||||
28
.github/workflows/tests.yml
vendored
28
.github/workflows/tests.yml
vendored
@@ -9,21 +9,31 @@ jobs:
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- name: Set up Python 3.8
|
||||
- name: Set up Python 3.9
|
||||
uses: actions/setup-python@v1
|
||||
with:
|
||||
python-version: 3.8
|
||||
python-version: 3.9
|
||||
|
||||
- name: Clone repo
|
||||
run: |
|
||||
git clone https://github.com/aceisace/Inkycal
|
||||
git clone --branch feature/venv --single-branch https://github.com/aceisace/Inkycal
|
||||
|
||||
- name: Install dependencies and run
|
||||
- name: Creating virtual evvironment
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
cd Inkycal
|
||||
pip3 install -e ./
|
||||
cd inkycal/modules && ls -al
|
||||
cd ..
|
||||
cd tests
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
echo "$PWD"
|
||||
pip install wheel
|
||||
pip install -e ./
|
||||
|
||||
- name: Setup test environment and run tests
|
||||
run: |
|
||||
cd inkycal/tests
|
||||
echo "${{ secrets.ENV_FILE }}" > .env
|
||||
wget https://raw.githubusercontent.com/aceisace/Inkycal/assets/tests/settings.json
|
||||
for f in *.py; do python3 "$f"; done
|
||||
|
||||
Reference in New Issue
Block a user