lynnesbian
/
bcao
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated readme and such

This commit is contained in:
Lynne Megido 2021-01-18 23:06:13 +10:00
parent e721a85fd2
commit 32369ce98a
Signed by: lynnesbian
GPG Key ID: F0A184B5213D9F90
3 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
.idea/workspace.xml
View File

@ -20,14 +20,9 @@
</component>
<component name="ChangeListManager">
<list default="true" id="f581197a-f26b-4fde-b746-e72c0ed1bb2a" name="Default Changelist" comment="my py dot ini">
<change beforePath="$PROJECT_DIR$/.gitignore" beforeDir="false" afterPath="$PROJECT_DIR$/.gitignore" afterDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/bcao.iml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/bcao.iml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/misc.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/misc.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/bcao/__init__.py" beforeDir="false" afterPath="$PROJECT_DIR$/bcao/__init__.py" afterDir="false" />
<change beforePath="$PROJECT_DIR$/bcao/__main__.py" beforeDir="false" afterPath="$PROJECT_DIR$/bcao/__main__.py" afterDir="false" />
<change beforePath="$PROJECT_DIR$/bcao/song_info.py" beforeDir="false" afterPath="$PROJECT_DIR$/bcao/song_info.py" afterDir="false" />
<change beforePath="$PROJECT_DIR$/requirements.txt" beforeDir="false" afterPath="$PROJECT_DIR$/requirements.txt" afterDir="false" />
<change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
<change beforePath="$PROJECT_DIR$/pyproject.toml" beforeDir="false" afterPath="$PROJECT_DIR$/pyproject.toml" afterDir="false" />
</list>
<option name="SHOW_DIALOG" value="false" />
<option name="HIGHLIGHT_CONFLICTS" value="true" />
@ -145,7 +140,7 @@
<workItem from="1603714609431" duration="5637000" />
<workItem from="1603720261881" duration="8249000" />
<workItem from="1605688147310" duration="310000" />
<workItem from="1610959328356" duration="9022000" />
<workItem from="1610959328356" duration="11553000" />
</task>
<task id="LOCAL-00001" summary="mp3 support! more helpful interface! better code! yahoo!!">
<created>1602927759343</created>

14
README.md
View File

@ -10,29 +10,39 @@ bandcamp album organiser - a python script to organise, rename, and apply cover
see the help menu (`--help`) for more.
## installing
### the astoundingly easy way
*requires [pipx](https://pipxproject.github.io/pipx/).*
this will run bcao without installing it, and it will be removed from your system afterwards.
```
pipx run --spec git+https://git.bune.city/lynnesbian/bcao bcao [album name.zip]
```
### the very easy way
download [bcao.pex](https://git.bune.city/lynnesbian/bcao/raw/branch/master/bcao.pex) and run it:
```
python bcao.pex [album name.zip]
```
a [pex file](https://github.com/pantsbuild/pex/) is a zip that contains everything needed for a python program to run,
including its dependencies.
### the pretty easy way
requires [poetry](https://python-poetry.org/).
installs the package into a virtual environment in the current directory.
```
git clone https://git.bune.city/lynnesbian/bcao
cd bcao
poetry install
poetry run bcao
poetry run bcao [album name.zip]
```
### the other way
you don't *have* to create a virtualenv, but, y'know, you should and all
```
git clone https://git.bune.city/lynnesbian/bcao
cd bcao
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
python -m bcao
python -m bcao [album name.zip]
```
## building it yourself

2
pyproject.toml
View File

@ -6,7 +6,7 @@ authors = ["Lynne <lynne@bune.city>"]
license = "GPL3"
[tool.poetry.dependencies]
python = "^3.9"
python = "^3.6"
mutagen = "^1.45.1"
Pillow = "^8.1.0"