flexlate-dev


Nameflexlate-dev JSON
Version 0.22.0 PyPI version JSON
download
home_page
SummaryDevelopment tools for template authors using Flexlate
upload_time2023-01-28 14:12:27
maintainer
docs_urlNone
authorNick DeRobertis
requires_python>=3.8,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            

[![](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:

```
<type>[optional scope]: <description>
```

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.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "flexlate-dev",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Nick DeRobertis",
    "author_email": "derobertis.nick@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/28/c4/29bd3942c6c6cd2f559025ab6671a1f600d7e0e588c20445c2b672393f32/flexlate_dev-0.22.0.tar.gz",
    "platform": null,
    "description": "\n\n[![](https://codecov.io/gh/nickderobertis/flexlate-dev/branch/master/graph/badge.svg)](https://codecov.io/gh/nickderobertis/flexlate-dev)\n[![PyPI](https://img.shields.io/pypi/v/flexlate-dev)](https://pypi.org/project/flexlate-dev/)\n![PyPI - License](https://img.shields.io/pypi/l/flexlate-dev)\n[![Documentation](https://img.shields.io/badge/documentation-pass-green)](https://nickderobertis.github.io/flexlate-dev/)\n![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)\n[![Github Repo](https://img.shields.io/badge/repo-github-informational)](https://github.com/nickderobertis/flexlate-dev/)\n\n\n#  flexlate-dev\n\n## Overview\n\nDevelopment tools for template authors using Flexlate\n\n## Getting Started\n\nInstall `flexlate-dev`:\n\n```\npip install flexlate-dev\n```\n\nA simple example:\n\n```python\nimport flexlate_dev\n\n# Do something with flexlate_dev\n```\n\nSee a\n[more in-depth tutorial here.](\nhttps://nickderobertis.github.io/flexlate-dev/tutorial.html\n)\n\n## Links\n\nSee the\n[documentation here.](\nhttps://nickderobertis.github.io/flexlate-dev/\n)\n\n## Development Status\n\nThis project is currently in early-stage development. There may be\nbreaking changes often. While the major version is 0, minor version\nupgrades will often have breaking changes.\n\n## Developing\n\n### Initial Setup\n\nFirst, you need a couple global dependencies installed, see their documentation for details:\n- [direnv](https://direnv.net/docs/installation.html)\n- [asdf](https://asdf-vm.com/guide/getting-started.html)\n\nNote that these tools require a UNIX-style shell, such as bash or zsh. If\nyou are on Windows, you can use WSL or Git Bash. If you are using Pycharm,\nyou can configure the built-in terminal to use Git Bash.\n\nThen clone the repo and run `direnv allow`. This will take a while on the first time\nto install the remaining dependencies.\n\n### Day to Day Development\n\nMake your changes and then run `just` to run formatting,\nlinting, and tests.\n\nDevelop documentation by running `just docs` to start up a dev server.\n\nTo run tests only, run `just test`. You can pass additional arguments to pytest,\ne.g. `just test -k test_something`.\n\nPrior to committing, you can run `just` with no arguments to run all the checks.\n\n#### Conventional Commits & Semantic Release\n\nThis project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)\nto power [semantic release](https://semantic-release.gitbook.io/semantic-release/). This means\nthat when you commit, you should use the following format:\n\n```\n<type>[optional scope]: <description>\n```\n\nFor example, `feat: Add new feature` or `fix: Fix bug`.\n\nWhen creating a PR, please name the PR in this way as well so that the squashed\ncommit from the PR will have a conventional commit message.\n\n#### Pre-commit Hooks\n\nThis project uses Husky and Lint-staged to run pre-commit hooks. This means that\nwhen you commit, it will run `just format` and `just strip` on the files\nyou edited, and also check that your commit message is a conventional commit.\n\nIf you are not able to commit, it is likely because your commit message is not\nin the conventional commit format.\n\n## Author\n\nCreated by Nick DeRobertis. MIT License.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Development tools for template authors using Flexlate",
    "version": "0.22.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "046afce0dc2742bbcad05613797b8c9632fa814a0c466c742e2398b8d5993e05",
                "md5": "471fedacc9c1ecfae88f6a77bc59d109",
                "sha256": "16463f77751715f21e08a39eddaf9a793dcf600b91d66058d92168395ac5cb11"
            },
            "downloads": -1,
            "filename": "flexlate_dev-0.22.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "471fedacc9c1ecfae88f6a77bc59d109",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 27796,
            "upload_time": "2023-01-28T14:12:26",
            "upload_time_iso_8601": "2023-01-28T14:12:26.398092Z",
            "url": "https://files.pythonhosted.org/packages/04/6a/fce0dc2742bbcad05613797b8c9632fa814a0c466c742e2398b8d5993e05/flexlate_dev-0.22.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "28c429bd3942c6c6cd2f559025ab6671a1f600d7e0e588c20445c2b672393f32",
                "md5": "1ff6c8e465bd0357036a78e7319fdf97",
                "sha256": "4af0b6ceb0e47442aad939032b1be837fb9d38b65bb1c5e33aa4171a269fecb5"
            },
            "downloads": -1,
            "filename": "flexlate_dev-0.22.0.tar.gz",
            "has_sig": false,
            "md5_digest": "1ff6c8e465bd0357036a78e7319fdf97",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 21399,
            "upload_time": "2023-01-28T14:12:27",
            "upload_time_iso_8601": "2023-01-28T14:12:27.647405Z",
            "url": "https://files.pythonhosted.org/packages/28/c4/29bd3942c6c6cd2f559025ab6671a1f600d7e0e588c20445c2b672393f32/flexlate_dev-0.22.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-28 14:12:27",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "flexlate-dev"
}
        
Elapsed time: 0.03344s