Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Rizhiy committed Mar 2, 2024
1 parent a34c835 commit ead579a
Showing 1 changed file with 8 additions and 33 deletions.
41 changes: 8 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,11 @@
[![pipeline status](https://gitlab.com/neurotrade1/utils/nt-utils/badges/master/pipeline.svg)](https://gitlab.com/neurotrade1/utils/nt-utils/-/commits/master)
[![coverage report](https://gitlab.com/neurotrade1/utils/nt-utils/badges/master/coverage.svg)](https://gitlab.com/neurotrade1/utils/nt-utils/-/commits/master)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
# Useful tools for Python

## Installation

Released version: `pip install nt-utils`

## Development

Editable installation:

```bash
pip install -U 'pip>=21.3.1' && \
git clone git@[email protected]:utilities/nt-utils && \
cd nt-utils && \
pip install -e '.[dev,tests]'
```

### Formatting
![tests](https://github.com/Rizhiy/replete/actions/workflows/test_and_version.yml/badge.svg)
[![codecov](https://codecov.io/gh/Rizhiy/replete/graph/badge.svg?token=FHM9FQ6IIU)](https://codecov.io/gh/Rizhiy/replete)
![publish](https://github.com/Rizhiy/replete/actions/workflows/publish.yml/badge.svg)
![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FRizhiy%2Freplete%2Fmaster%2Fpyproject.toml)
[![PyPI - Version](https://img.shields.io/pypi/v/replete)](https://pypi.org/project/replete/)

This repository follows strict formatting style which will be checked by the CI.

To properly format the code, use the `nt-dev` package:

```bash
pip install nt-dev
nt-format
```

### Testing

Before pushing a commit, you can run `nt-test --format` which will try to
format the files and run tests.
## Installation

This project is _preferentially_ `mypy --strict` typed, without enforcement in CI.
Released version: `pip install replete`

0 comments on commit ead579a

Please sign in to comment.