semvec/pypi-packages huggingface dataset:
swagger-yamltohtml 0.0.0
Converts a swagger-generated yaml into html code
Requires Python: >=3.6

# Swagger Standalone

This package converts yaml generated by swagger into html code!

### To build and send package

First, configure and start the python virtual environment!

Remove `dist` and `src/swagger_yamltohtml.egg-info` folders, if they exist:
```
rm -R dist
rm -R src/swagger_yamltohtml.egg-info
```

At least, change the version number in `setup.py`.

Install/Update this packages:
```
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
python3 -m pip install --upgrade twine
```

Run in the root directory for build package:
```
python3 -m build
```

## Using test.pypi

After, run the command and insert your test.pypi credentials or your api token:
```
python3 -m twine upload --repository testpypi dist/*
```

- ### To Install package

To install run below code:
```
python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps swagger-yamltohtml --extra-index-url https://pypi.org/simple PyYAML
```

## Using py.pi

After, run the command and insert your test.pypi credentials or your api token:
```
python3 -m twine upload dist/*
```

- ### To Install package

To install run below code:
```
python3 -m pip install swagger-yamltohtml -U
```

## How to use
### Import and configurate into your code:
example.py
```py
from swagger_yamltohtml.yaml2html import convertYamlInHtml
from os import dirname, realpath
...
converted_html = convertYamlInHtml(dirname(realpath(__file__)))
...

```
### Flags
- #### --yaml-file <yaml-file-path>
To select yaml file to convert in html. Without this flag, input mode is ON!

Ex: 
```
python3 example.py --yaml-file example.yaml
```
<!--
<br>

- #### --html-file <html-file-path>
To select base html file for convert. This file must have the same structure as the base. Without this flag, is used default html file!
--
Ex:
```
python3 example.py --html-file example.html
```
-->
HenruSeApp 0.0.0
Insert project description here
Requires Python: >=3.6

.. image:: https://img.shields.io/pypi/status/HenruSeApp
    :alt: PyPI - Status

.. image:: https://img.shields.io/pypi/wheel/HenruSeApp
    :alt: PyPI - Wheel

.. image:: https://img.shields.io/pypi/pyversions/HenruSeApp
    :alt: PyPI - Python Version

.. image:: https://img.shields.io/github/v/release/hendrikdutoit/HenruSeApp
    :alt: GitHub release (latest by date)

.. image:: https://img.shields.io/github/license/hendrikdutoit/HenruSeApp
    :alt: License

.. image:: https://img.shields.io/github/issues-raw/hendrikdutoit/HenruSeApp
    :alt: GitHub issues

.. image:: https://img.shields.io/pypi/dm/HenruSeApp
    :alt: PyPI - Downloads

.. image:: https://img.shields.io/github/search/hendrikdutoit/HenruSeApp/GitHub
    :alt: GitHub Searches

.. image:: https://img.shields.io/codecov/c/gh/hendrikdutoit/HenruSeApp
    :alt: CodeCov
    :target: https://app.codecov.io/gh/hendrikdutoit/HenruSeApp

.. image:: https://img.shields.io/github/workflow/status/hendrikdutoit/HenruSeApp/Pre-Commit
    :alt: GitHub Actions - Pre-Commit
    :target: https://github.com/hendrikdutoit/HenruSeApp/actions/workflows/pre-commit.yaml

.. image:: https://img.shields.io/github/workflow/status/hendrikdutoit/HenruSeApp/CI
    :alt: GitHub Actions - CI
    :target: https://github.com/hendrikdutoit/HenruSeApp/actions/workflows/ci.yaml

.. image:: https://img.shields.io/pypi/v/HenruSeApp
    :alt: PyPi

Project Short Description (default ini)

    Project long description or extended summary goes in here (default ini)

=======
Testing
=======

This project uses ``pytest`` to run tests and also to test docstring examples.

Install the test dependencies.

.. code-block:: bash

    $ pip install - r requirements_test.txt

Run the tests.

.. code-block:: bash

    $ pytest tests
    === XXX passed in SSS seconds ===

==========
Developing
==========

This project uses ``black`` to format code and ``flake8`` for linting. We also support ``pre-commit`` to ensure these have been run. To configure your local environment please install these development dependencies and set up the commit hooks.

.. code-block:: bash

    $ pip install black flake8 pre-commit
    $ pre-commit install

=========
Releasing
=========

Releases are published automatically when a tag is pushed to GitHub.

.. code-block:: bash

    # Set next version number
    export RELEASE = x.x.x
    
    # Create tags
    git commit --allow -empty -m "Release $RELEASE"
    git tag -a $RELEASE -m "Version $RELEASE"
    
    # Push
    git push upstream --tags