Skip to content

Commit

Permalink
workflow for publishing wheel added
Browse files Browse the repository at this point in the history
  • Loading branch information
grimmpp committed Feb 3, 2024
1 parent c21e511 commit 8498ccb
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 12 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,6 @@ jobs:

- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
- with:
- username: __token__
- password: ${{ secrets.PYPI_TOKEN }}
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,24 +18,27 @@ What you can see here can automatically detected by reading the memory of the bu
Additional info for Home Assistant is automatically added. The configuration for Home Assistant can be generated by the detected information.
For further steps it is planned to extend the support for changing the data which was collected so that a proper management of the devices can be supported.

## Install python package
1. Clone/Download the repo.
2. Change into the repo directory.
3. Create virtual environment for python: `python.exe -m venv .venv`
4. Install dependencies: `.\.venv\Scripts\python.exe steup.py install`
5. Run it: `.\.venv\Scripts\python.exe eo-man`
## Install python package in virtual environment (Recommended)
1. Create virtual python environment: `python.exe -m venv .\.venv`
2. Install application: `.\.venv\Scripts\pip.exe install eo-man` (Package available under pypi: [eo-man](https://pypi.org/project/eo-man/))
3. Run application: `.\.venv\Scripts\python eo-man`

## Install python package in gloabl environment
1. Install application: `pip.exe install eo-man` (Package available under pypi: [eo-man](https://pypi.org/project/eo-man/))
2. Run application: `python eo-man`

## Install dependencies and run the App (alternativ)
## Install source code from this repository and run the App (alternative)
1. Clone/Download the repo.
2. Change into the repo directory.
3. Create virtual environment for python: `python.exe -m venv .venv`
4. Install dependencies: `.\.venv\Scripts\pip.exe install -r .\requirements.txt` (This step takes a bit.)
Sometimes you need to run this step twice.
5. Start the app: `.\.venv\Scripts\python.exe eo-man` or `.\.venv\Scripts\python.exe eo-man demo.eodm` directly loads demo data
4. Install dependencies: `.\.venv\Scripts\python.exe setup.py install`
5. Start the app: `.\.venv\Scripts\python.exe eo-man` or `.\.venv\Scripts\python.exe eo-man demo.eodm` (Directly loads demo data)

For update you can execute:
1. `git pull` (Gets newest state of the code)
2. `.\.venv\Scripts\pip.exe install -r .\requirements.txt` installs changes of dependencies. Sometimes I have to execute this command twice. (I often adapt the [eltako14bus](https://github.com/grimmpp/eltako14bus) library for communicaiton to the bus.)
2. Optionally change branch: `git checkout BRANCH_NAME`
3. Reinstall`.\.venv\Scripts\python.exe setup.py install --force`
4. Run app: `.\.venv\Scripts\python.exe eo-man`

## Bugs and Features
Please open [issues](/issues) if you encounter bugs or if you have ideas for new features. Also quite a lot of devices are not yet supported.
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

setup(
name='eo-man',
version='0.1-rc',
version='0.1-rc1',
package_dir={'':"eo-man"},
# packages=find_packages("./eo-man"),
package=['view', 'data', 'controller', 'icons'],
Expand Down

0 comments on commit 8498ccb

Please sign in to comment.