semvec/pypi-packages huggingface dataset:
rstms-pymod 0.0.5
Top-level package for rstms-pymod.
Keywords: rstms_pymod

rstms-pymod
===========


![Image](https://img.shields.io/github/license/rstms/rstms_pymod)

![Image](https://img.shields.io/pypi/v/rstms_pymod.svg)


![Image](https://circleci.com/gh/rstms/rstms_pymod/tree/master.svg?style=shield)

![Image](https://readthedocs.org/projects/rstms-pymod/badge/?version=latest)


python module management tool


* Free software: MIT license
* Documentation: https://rstms-pymod.readthedocs.io.



Credits
-------

This package was created with Cookiecutter and `rstms/cookiecutter-python-cli`, a fork of the `audreyr/cookiecutter-pypackage` project template.

[audreyr/cookiecutter](https://github.com/audreyr/cookiecutter)
[audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage)
[rstms/cookiecutter-python-cli](https://github.com/rstms/cookiecutter-python-cli)
start-code 0.0.1
Boilerplate Python Code
Requires Python: >=3.10,<4.0

# Name of Project Title Here

Enter brief description.

## Gotchas

- When `poetry update` fails, search for libraries.
- Upgrade pip: `pip3 install -U pip` inside the .venv, i.e. in `poetry shell`
- Use `pip3` instead of `poetry add` or `poetry update` when third-party library install fails, e.g. `pip3 install -U virtualenv`.

## Quickstart

### Copy from source

1. `gh repo clone justmars/start_code` _target_
2. Rename `start_code` folder to _target_ or delete
3. Add `.vscode` to `.gitignore`

### Set python version

1. Check [.python-version](./.python-version), default is 3.10.7
2. Run `poetry env use $(pyenv which python)` if `.python-version` has been updated. See [ticket](https://github.com/python-poetry/poetry/issues/651#issuecomment-1073213937)
3. Review created .venv folder's `pyvenv.cfg` this should show the version declared in `.python-version`

## Configure package

1. Open [pyproject.toml](./pyproject.toml)
2. Change `name` from `start_code` to `desired-package-name` (not a duplicate in pypi)
3. Add description
4. Remove dependencies that aren't applicable, e.g. `tqdm`
5. Create the virtual environment via `poetry install`

## Setup git repo

Note: can avoid this section if not creating a repository

While virtual environment being installed, create new repo. Get repo `<url>`

```zsh
> `rm -rf .git` # remove cloned .git file
> `git init -b main`
> `git add .`
> `git commit -m "first"`
> `git remote add origin` <url> # from created repo
> `pre-commit run -a`
> `git push -u origin main`
```

## Cleanup

1. Add license, repository, packages to [pyproject.toml](./pyproject.toml), when ready.
2. Delete contents of this README from `Gotchas` going down.
3. Update precommit [config](./pre-commit-config.yaml) version numbers to match [pyproject.toml](./pyproject.toml), in case these have been updated.