Skip to content
This repository has been archived by the owner on Jan 13, 2024. It is now read-only.

Commit

Permalink
update libraries
Browse files Browse the repository at this point in the history
move/rename project in preparation for pypi name
replace tabs by 4 spaces
add git ignore
remove __pycache__ extra dir
add github action to build when a tag is done
  • Loading branch information
i30817 committed Sep 11, 2022
1 parent 6c96217 commit 2e7f3bb
Show file tree
Hide file tree
Showing 7 changed files with 501 additions and 326 deletions.
46 changes: 46 additions & 0 deletions .github/workflows/libretro_scummvm_playlist.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Release

on:
release:
types: [created]

jobs:
multibuild:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: "3.10"
- name: Install Poetry
uses: abatilo/[email protected]
with:
poetry-version: "1.1.15"
- name: Build wheels
run: |
poetry build
- name: Upload wheels
uses: actions/upload-artifact@v2
with:
name: wheels
path: dist

release:
name: Release
if: github.event_name == 'release' && github.event.action == 'created'
runs-on: ubuntu-latest
needs: [ multibuild ]
steps:
- uses: actions/download-artifact@v2
with:
name: wheels
- uses: actions/setup-python@v2
with:
python-version: "3.10"
- name: Publish to PyPi
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
run: |
pip install --upgrade twine
twine upload --skip-existing *
129 changes: 129 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/
22 changes: 11 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,24 @@ downloader' in retroarch if you're running the normal core [1]_.
scummvm.ini, in the game dir so the manual scanner can scan the .scummvm
files and assign it a playlist entry.

libretro-mkscumm removes the need for step 3 and 4 if you did step 1 and 2.
libretro-scummvm-playlist removes the need for step 3 and 4 if you did step 1 and 2.

To update this program with pip installed, type:
To update this program to the latest release with pip installed, type:

``pip install --upgrade git+https://github.com/i30817/libretro-mkscumm.git``
``pip install --force-reinstall libretro_scummvm_playlist``

If you'd like to try to download missing coverart until a PR with scummvm
names is added to the thumbnail server try to install and use libretrofuzz:

``pip install git+https://github.com/i30817/libretrofuzz.git``
``pip install --force-reinstall libretro_fuzz``

.. [1] The diablodiab daily build core at http://build.bot.nu/nightly/ requires updated files from scummvm upstream, you can get them with:
http://build.bot.nu/assets/system/ScummVM.zip
Then extract the zip into the retroarch ``system`` directory.
libretro-mkscumm [OPTIONS] [CFG]
libretro-scummvm-playlist [OPTIONS] [CFG]
:CFG: Path to the retroarch cfg file. If not default, asked from the user.

Linux default: ``~/.config/retroarch/retroarch.cfg``
Expand All @@ -62,10 +62,10 @@ libretro-mkscumm [OPTIONS] [CFG]

To install the program, type on the cmd line

+---------------------+-----------------------------------------------------------------------------------------------------------+
| Linux | ``pip install --force-reinstall https://github.com/i30817/libretro-mkscumm/archive/master.zip`` |
+---------------------+-----------------------------------------------------------------------------------------------------------+
| Windows | ``python -m pip install --force-reinstall https://github.com/i30817/libretro-mkscumm/archive/master.zip`` |
+---------------------+-----------------------------------------------------------------------------------------------------------+
+----------------+-------------------------------------------------------------------------------------------------+
| Latest release | ``pip install --force-reinstall libretro_scummvm_playlist`` |
+----------------+-------------------------------------------------------------------------------------------------+
| Current code | ``pip install --force-reinstall https://github.com/i30817/libretro-mkscumm/archive/master.zip`` |
+----------------+-------------------------------------------------------------------------------------------------+

In windows, you'll want to check the option to “Add Python to PATH” when installing python, to be able to execute the script from any path of the cmd line.
In windows, you'll want to check the option to “Add Python to PATH” when installing python, to be able to install and execute the script from any path of the cmd line
Loading

0 comments on commit 2e7f3bb

Please sign in to comment.