Skip to content

MislavJaksic/Wiki-Tools

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wiki Tools

# Note: Install Python 3

# Note: install Poetry for Linux
$: curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python

# Note: install Poetry for Windows
$: (Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python
# Note: do NOT update Poetry, it will break itself

$: python get-poetry.py --uninstall
# Note: `.toml` project name and package have no match (wiki-tools; wiki_tools)
$: poetry install  # install all dependencies

dist

$: pip install dist/wiki_tools-0.0.1-py3-none.any.whl

$: wiki-tools

docs

$: poetry shell
$: cd docs
# Note: review source/conf.py and source/index.rst
$: make html
# Note: see docs in docs/build/apidocs/index.html

wiki_tools

$: poetry run python ./wiki_tools/runner.py

tests

$: poetry run pytest --durations=0
$: poetry run pytest --cov=wiki_tools --cov-report=html tests
#: Note: see coverage report in htmlcov/index.html

poetry.lock

Dependencies, Python version and the virtual environment are managed by Poetry.

$: poetry search Package-Name
$: poetry add [-D] Package-Name[==Package-Version]

pyproject.toml

Define project entry point and metadata.

setup.cfg

Configure Python libraries.

Linters

$: poetry run black .

Publish

$: poetry config pypi-token.pypi PyPI-API-Access-Token

$: poetry publish --build
https://pypi.org/project/wiki-tools/

Nodejs Scripts

Before running any script with node Script-Name.mjs make sure you:

  • Run npm install node-fetch to install the script dependency.
  • Fill out the secrets_wiki-template.mjs

Releases

No releases published

Packages

No packages published