semvec/pypi-packages huggingface dataset:
docpy 0.1.1
Python to MD documentation generator
License: BSD-3-Clause

# docpy

This package auto-generates Markdown documentation from Python files.

## Installation

This package is installed using pip:

```
pip install docpy
```

## Usage

This package is used from the command line:

```
docpy ...
```

The package help entry is given below.

```
usage: docpy [-h] [-a APPEND] [-o OUT] [-s SUB] [-t TEMP] ...

generate Markdown documentation for Python files

positional arguments:
  files                 files to be documented

optional arguments:
  -h, --help            show this help message and exit
  -a APPEND, --append APPEND
                        file to which to append generated Markdown
  -o OUT, --output OUT  file to save generated Markdown to
  -s SUB, --sub SUB     file with ::DOCUMENTATION:: tag to replace Markdown
  -t TEMP, --template TEMP
                        template file with ::DOCUMENTATION:: tag, needs OUT
                        argument
```

### Templates

You can define a Markdown template in which your documentation will be placed using the `-t` flag, which must be used in conjunction with the `-o` flag. In your template, just put `::DOCUMENTATION::` where you want the documentation to be placed. For example,

```markdown
# This is a markdown file.

My docs are below:

::DOCUMENTATION::

_this concludes the documentation._
```

## Changelog

**v0.1.1:**

* Fixed formatting error in docstrings

**v0.1.0:**

* Initial release
mcafee-epo 1.1.0
McAfee ePolicy Orchestrator API client
License: BSD-3-Clause
Requires Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*

Python client for McAfee ePolicy Orchestrator
=============================================

A straightforward wrapper around the ePO API. Manages authentication,
building requests, and interpreting responses. Simply treat the client
object as a callable function, passing the command name and parameters.

Install::

    $ pip install mcafee-epo

Use::

    >>> from mcafee_epo import Client
    >>> client = Client('https://localhost:8443', 'user', 'password')
    >>> systems = client('system.find', '')


Differences from "official" client
----------------------------------

This library was created in response to the fairly poor client
distributed by McAfee, which didn't support Python 3 and was generally
a mess. (You can find a cleaned up version of their client with Python 3
support in the first few commits.)

The official library requires copying files into the Python location to
"install" it. This library is an actual package installed using ``pip``.

The official client uses low level url libraries and numerous
workarounds to make http requests. This library uses the
`requests <http://python-requests.org/>`_ library to greatly simplify
the work the previous code was doing while offering better security.

The official client uses a dynamic command discovery and dispatch
mechanism to make API calls seem like a nested set of objects. This
library forgoes that complexity (which wasn't understood by IDEs anyway)
for a more straightforward approach that just accepts command names when
calling.


Links
-----

-   Releases: https://pypi.org/project/mcafee-epo/
-   Code: https://github.com/davidism/mcafee-epo