Skip to content

Commit

Permalink
Add a constraint on more_itertools in Pipfile (#349)
Browse files Browse the repository at this point in the history
  • Loading branch information
draftcode committed Dec 14, 2021
1 parent 6b20310 commit d9a1d4d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
1 change: 1 addition & 0 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ types-requests = "*"
types-pkg_resources = "*"
types-tabulate = "*"
unittest-xml-reporting = "*"
more_itertools = "<8.6"

[packages]
launchable = {editable = true, path = "."}
Expand Down
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,53 @@
# Usage

See https://docs.launchableinc.com/cli-reference and https://docs.launchableinc.com/getting-started.
See https://docs.launchableinc.com/cli-reference and
https://docs.launchableinc.com/getting-started.

# Development

## Preparation

We recommend Pipenv

```shell
pip install pipenv
pip install pipenv==2021.5.29
pipenv install --dev
```

Note that you will need to use 2021.5.29 as the Python version is fixed at 3.5,
and the Pipenv beyond that version won't support Python 3.5 or below.

If you mess up your local pipenv, `pipenv --rm` will revert the operation above.

In order to automatically format files with autopep8, this repository contains a
configuration for [pre-commit](https://pre-commit.com). Install the hook with
`pipenv run pre-commit install`.

## Load development environment

```shell
pipenv shell
```

## Run tests

```shell
pipenv run test
```

## Add dependency

```shell
pipenv install --dev some-what-module
```

# How to release
Create new release on Github, then Github Actions automatically uploads the module to PyPI.

Create new release on Github, then Github Actions automatically uploads the
module to PyPI.

## Versioning

This module follows [Semantic versioning](https://semver.org/) such as X.Y.Z.

* Major (X)
Expand Down

0 comments on commit d9a1d4d

Please sign in to comment.