sxmi-marker 0.0.0

Generates markers for SXMI modules

sxmi-marker

Generates markers for SXMI modules

Using

Python package: To add and install this package as a dependency of your project, run poetry add sxmi-marker.

Python CLI: To view this app's CLI commands once it's installed, run sxmi-marker --help.

Setting up your development environment

Prerequisites

1. Generate an SSH key and add the SSH key to your GitHub account.
2. Configure SSH to automatically load your SSH keys:

   cat << EOF >> ~/.ssh/config
   Host *
     AddKeysToAgent yes
     IgnoreUnknown UseKeychain
     UseKeychain yes
   EOF
   

3. Install Docker Desktop.
   • Enable Use Docker Compose V2 in Docker Desktop's preferences window.
   • Linux only:
     • Configure Docker and Docker Compose to use the BuildKit build system. On macOS and Windows, BuildKit is enabled by default in Docker Desktop.
     • Export your user's user id and group id so that files created in the Dev Container are owned by your user:

       cat << EOF >> ~/.bashrc
       export UID=$(id --user)
       export GID=$(id --group)
       EOF
       

4. Install VS Code and VS Code's Dev Containers extension.

One-time project setup

1. Clone this repository.
2. Start a Dev Container in your preferred development environment:
   • VS Code: open the cloned repository and run Ctrl/⌘ + ⇧ + P → Remote-Containers: Reopen in Container.
   • Terminal: open the cloned repository and run docker compose up --detach dev to start the Dev Container in the background, and then run docker compose exec dev zsh to open a shell prompt in the Dev Container.

Browser development setup

1. Open https://github.com/Stroma-Vision/sxmi-marker in your browser.
2. Click on Code and select Create codespace to start a Dev Container with GitHub Codespaces.

Developing

• This project follows the Conventional Commits standard to automate Semantic Versioning and Keep A Changelog with Commitizen.
• Run poe from within the development environment to print a list of Poe the Poet tasks available to run on this project.
• Run poetry add {package} from within the development environment to install a run time dependency and add it to pyproject.toml and poetry.lock. Add --group test or --group dev to install a CI or development dependency, respectively.
• Run poetry update from within the development environment to upgrade all dependencies to the latest versions allowed by pyproject.toml.
• Run cz bump to bump the package's version, update the CHANGELOG.md, and create a git tag.