File: README.md

package info (click to toggle)
python-intellifire4py 4.1.9-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 620 kB
  • sloc: python: 2,585; sh: 13; makefile: 5
file content (73 lines) | stat: -rw-r--r-- 2,490 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# Intellifire4Py

[![PyPI](https://img.shields.io/pypi/v/intellifire4py.svg)][pypi_]
[![Status](https://img.shields.io/pypi/status/intellifire4py.svg)][status]
[![Python Version](https://img.shields.io/pypi/pyversions/intellifire4py)][python version]
[![License](https://img.shields.io/pypi/l/intellifire4py)][license]

[![Read the documentation at https://intellifire4py.readthedocs.io/](https://img.shields.io/readthedocs/intellifire4py/latest.svg?label=Read%20the%20Docs)][read the docs]
[![Tests](https://github.com/jeeftor/intellifire4py/workflows/Tests/badge.svg)][tests]
[![Codecov](https://codecov.io/gh/jeeftor/intellifire4py/branch/master/graph/badge.svg)][codecov]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]

[pypi_]: https://pypi.org/project/intellifire4py/
[status]: https://pypi.org/project/intellifire4py/
[python version]: https://pypi.org/project/intellifire4py
[read the docs]: https://intellifire4py.readthedocs.io/
[tests]: https://github.com/jeeftor/intellifire4py/actions?workflow=Tests
[codecov]: https://app.codecov.io/gh/jeeftor/intellifire4py
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black

## Features

- TODO

## Requirements

- TODO

## Installation

You can install _Intellifire4Py_ via [pip] from [PyPI]:

```console
$ pip install intellifire4py
```

## Usage

Please see the [API Reference] for details.

## Contributing

Contributions are very welcome.
To learn more, see the [Contributor Guide].

## License

Distributed under the terms of the [MIT license][license],
_Intellifire4Py_ is free and open source software.

## Issues

If you encounter any problems,
please [file an issue] along with a detailed description.

## Credits

This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.

[@cjolowicz]: https://github.com/cjolowicz
[pypi]: https://pypi.org/
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
[file an issue]: https://github.com/jeeftor/intellifire4py/issues
[pip]: https://pip.pypa.io/

<!-- github-only -->

[license]: https://github.com/jeeftor/intellifire4py/blob/main/LICENSE
[contributor guide]: https://github.com/jeeftor/intellifire4py/blob/main/CONTRIBUTING.md
[command-line reference]: https://intellifire4py.readthedocs.io/en/latest/usage.html