semvec/pypi-packages huggingface dataset:
readme-md 2019.1.28
README.md generator
Keywords: readme markdown

[![](https://img.shields.io/pypi/pyversions/readme-md.svg?longCache=True)](https://pypi.org/project/readme-md/)

#### Install
```bash
$ [sudo] pip install readme-md
```

#### Features
+   **`<section-name>.md` sections**
+   **attrs/properties/methods sections** - subclass `readme_md.Readme`
+   **auto headers** - if section 1st line is not empty and not `#` header
+   sections **order** - `Readme.order` or `order.txt`
+   python project ([`setup.cfg`](https://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files) required) sections - `install`, `classes`, `functions`, `cli`

#### Classes
`readme_md.Readme` - README.md generator

`Readme` attrs|`__doc__`
-|-
`header_lvl`|header default lvl (4)
`headers`|dict with sections headers (optional)
`order`|list of sections order
`sections`|dict with sections (loaded from .md files)

`Readme` methods|`__doc__`
-|-
`get_header(name)`|return a string with section header
`get_section(name)`|return a string with README section
`get_sections()`|return all sections in a list of (name, string) pairs sorted by `order`
`load(path)`|load sections and order
`render()`|render to a string
`save(path='README.md')`|save to file

#### Functions
function|`__doc__`
-|-
`readme_md.broken_links(string, timeout=5)`|return a list with broken markdown links
`readme_md.links(string)`|return a list with markdown links
`readme_md.tables.attrs(cls)`|return a string with class attributes table
`readme_md.tables.cls(cls)`|return a string with class name, description and attrs+methods+properties tables
`readme_md.tables.methods(cls)`|return a string with class methods table
`readme_md.tables.properties(cls)`|return a string with class properties table
`readme_md.tables.usage(modules)`|return a string with cli modules usage table. `python -m module` or module `USAGE` variable (if defined). `if __name__ == "__main__"` line required

#### CLI
usage|`__doc__`
-|-
`python -m readme_md.broken_links path [timeout]`|print README.md broken links
`python -m readme_md.create [path ...]`|generate README.md
`python -m readme_md.links path`|print README.md links

#### Examples
```bash
# .README/examples.md, .README/features.md, .README/order.txt
$ python -m readme_md.create .README > README.md
$ python -m readme_md.broken_links README.md # find broken links
```

```python
class Readme_npm(readme_md.Readme):
    order = ["description","features","install", ...]
    disabled = ["generator"]

    @property
    def install(self):
        return "`$ [sudo] npm i -g %s`" % json.loads(path)["name"]
```

```python
Readme(".README").save("README.md") # load sections and create README.md
```

<p align="center"><a href="https://pypi.org/project/readme-md/">readme-md</a> - README.md generator</p>
cctf 0.1.2
CCTF

Crypto-Currencies Trading Framework.

Home-page: https://github.com/havocesp/cctf
Author: Daniel J. Umpierrez
Author-email: umpierrez@pm.me
License: UNLICENSE
Description: UNKNOWN
Keywords: altcoins,altcoin,exchange,bitcoin,trading
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
fusion123 0.1.0
Converts 123D design CAD files into Fusion 360 CAD files

# 123-Fusion
Converts 123D design CAD files into Fusion 360 CAD files

[![licence](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/bennymeg/AcademicEmailVerifier/blob/master/LICENSE)
[![](https://img.shields.io/pypi/v/:packageName.svg)](https://pypi.org/pypi/fusion123/)

<!-- ___
ðŸš§**NOTE:** this repository is still a work in progress, it has not been deployed to PyPi yet. In order to use it, please execute the converter script directly.
```
python converter.py [path/to/*.123dx]
```

* _if no file path is provided, the script will use the current script directory_
___ -->

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

You will need to install python 3 in order to use this software

### Installing

```
pip install fusion123
```
NOTE: the PyPi module name is _different_ then the repository name

### Running

```
python fusion123 [path/to/*.123dx]
```

### Coding style tests

Please use PyLint (Default linter on VS Code) to lint your code before submitting a PR.

## Contributing

Please read [CONTRIBUTING.md](https://github.com/bennymeg/123-Fusion/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/bennymeg/123-Fusion/tags). 

## Authors

**Benny Megidish**

_See also the list of [contributors](https://github.com/bennymeg/123-Fusion/contributors) who participated in this project._

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details