https://github.com/nickderobertis/flexlate-dev

Flexlate Development Tools
https://github.com/nickderobertis/flexlate-dev

Last synced: about 3 hours ago
JSON representation

Flexlate Development Tools

• Host: GitHub
• URL: https://github.com/nickderobertis/flexlate-dev
• Owner: nickderobertis
• License: mit
• Created: 2022-03-06T23:21:38.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-01-28T14:13:34.000Z (almost 2 years ago)
• Last Synced: 2024-12-25T05:46:18.078Z (about 1 month ago)
• Language: Python
• Size: 4.26 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


[![](https://codecov.io/gh/nickderobertis/flexlate-dev/branch/master/graph/badge.svg)](https://codecov.io/gh/nickderobertis/flexlate-dev)

[![PyPI](https://img.shields.io/pypi/v/flexlate-dev)](https://pypi.org/project/flexlate-dev/)

![PyPI - License](https://img.shields.io/pypi/l/flexlate-dev)

[![Documentation](https://img.shields.io/badge/documentation-pass-green)](https://nickderobertis.github.io/flexlate-dev/)

![Tests Run on Ubuntu Python Versions](https://img.shields.io/badge/Tests%20Ubuntu%2FPython-3.8%20%7C%203.9%20%7C%203.10-blue)

[![Github Repo](https://img.shields.io/badge/repo-github-informational)](https://github.com/nickderobertis/flexlate-dev/)

#  flexlate-dev

## Overview

Development tools for template authors using Flexlate

## Getting Started

Install `flexlate-dev`:

```

pip install flexlate-dev

```

A simple example:

```python

import flexlate_dev

# Do something with flexlate_dev

```

See a

[more in-depth tutorial here.](

https://nickderobertis.github.io/flexlate-dev/tutorial.html

)

## Links

See the

[documentation here.](

https://nickderobertis.github.io/flexlate-dev/

)

## Development Status

This project is currently in early-stage development. There may be

breaking changes often. While the major version is 0, minor version

upgrades will often have breaking changes.

## Developing

### Initial Setup

First, you need a couple global dependencies installed, see their documentation for details:

- [direnv](https://direnv.net/docs/installation.html)

- [asdf](https://asdf-vm.com/guide/getting-started.html)

Note that these tools require a UNIX-style shell, such as bash or zsh. If

you are on Windows, you can use WSL or Git Bash. If you are using Pycharm,

you can configure the built-in terminal to use Git Bash.

Then clone the repo and run `direnv allow`. This will take a while on the first time

to install the remaining dependencies.

### Day to Day Development

Make your changes and then run `just` to run formatting,

linting, and tests.

Develop documentation by running `just docs` to start up a dev server.

To run tests only, run `just test`. You can pass additional arguments to pytest,

e.g. `just test -k test_something`.

Prior to committing, you can run `just` with no arguments to run all the checks.

#### Conventional Commits & Semantic Release

This project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)

to power [semantic release](https://semantic-release.gitbook.io/semantic-release/). This means

that when you commit, you should use the following format:

```

[optional scope]: 

```

For example, `feat: Add new feature` or `fix: Fix bug`.

When creating a PR, please name the PR in this way as well so that the squashed

commit from the PR will have a conventional commit message.

#### Pre-commit Hooks

This project uses Husky and Lint-staged to run pre-commit hooks. This means that

when you commit, it will run `just format` and `just strip` on the files

you edited, and also check that your commit message is a conventional commit.

If you are not able to commit, it is likely because your commit message is not

in the conventional commit format.

## Author

Created by Nick DeRobertis. MIT License.