Preocts / writercast

Discord rich presence for writing

writercast

Note: Will not run without effort on WSL2 instances. This is due to a lack of AF_UNIX interop for WSL2. This can be worked around with socat and npiperelay. Perhapes this can be scripted in. WSL1 does not have this limitation. reference link

---

Local developer installation

The following steps outline how to install this repo for local development. See the CONTRIBUTING.md file in the repo root for information on contributing to the repo.

Prerequisites

Clone repo

git clone https://github.com/Preocts/writercast

cd writercast

Virtual Environment

Use a (venv), or equivalent, when working with python projects. Leveraging a venv will ensure the installed dependency files will not impact other python projects or any system dependencies.

Windows users: Depending on your python install you will use py in place of python to create the venv.

Linux/Mac users: Replace python, if needed, with the appropriate call to the desired version while creating the venv. (e.g. python3 or python3.8)

All users: Once inside an active venv all systems should allow the use of python for command line instructions. This will ensure you are using the venv's python and not the system level python.

Create the venv:

python -m venv venv

Activate the venv:

# Linux/Mac
. venv/bin/activate

# Windows
venv\Scripts\activate

The command prompt should now have a (venv) prefix on it. python will now call the version of the interpreter used to create the venv

To deactivate (exit) the venv:

deactivate

---

Developer Installation Steps

Install editable library and development requirements

python -m pip install --editable .[dev,test]

Install pre-commit (see below for details)

pre-commit install

---

Pre-commit and nox tools

Run pre-commit on all files

pre-commit run --all-files

Run tests with coverage (quick)

nox -e coverage

Run tests (slow)

nox

Build dist

nox -e build

---

Updating dependencies

New dependencys can be added to the requirements-*.in file. It is recommended to only use pins when specific versions or upgrades beyond a certain version are to be avoided. Otherwise, allow pip-compile to manage the pins in the generated requirements-*.txt files.

Once updated following the steps below, the package can be installed if needed.

Update the generated files with changes

nox -e update

Upgrade all generated dependencies

nox -e upgrade

---

pre-commit

A framework for managing and maintaining multi-language pre-commit hooks.

This repo is setup with a .pre-commit-config.yaml with the expectation that any code submitted for review already passes all selected pre-commit checks.

---

Error: File "setup.py" not found

Update pip to at least version 22.3.1