semvec/pypi-packages huggingface dataset:
html2docx 1.6.0
Convert valid HTML input to docx.
License: MIT
Requires Python: >=3.7

# html2docx

html2docx converts valid HTML input to docx output. The project is distributed
under the MIT license.

## Installing

To install, use pip:

```
$ pip install html2docx
```

## Usage

```py
from html2docx import html2docx

with open("my.html") as fp:
    html = fp.read()

# html2docx() returns an io.BytesIO() object. The HTML must be valid.
buf = html2docx(html, title="My Document")

with open("my.docx", "wb") as fp:
    fp.write(buf.getvalue())
```

## Testing

To run the test suite, use tox:

```
$ tox
```
codepost-powertools 0.1.0
Some helpful codePost tools to aid with grading flow.
License: MIT
Requires Python: >=3.7.2,<4.0.0
Keywords: codepost,tools,powertools,Google Sheets,Princeton,COS126

codePost Powertools
===================

.. badges

.. image:: https://readthedocs.org/projects/codepost-powertools/badge/?version=latest
   :target: https://codepost-powertools.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. |codePost SDK| replace:: ``codePost`` SDK
.. _codePost SDK: https://github.com/codepost-io/codepost-python

Some helpful codePost tools to aid with grading flow using the |codePost SDK|_!

These tools were originally created to support the grading process for COS126,
the introductory Computer Science course at Princeton University.

.. end-intro

Documentation
-------------

The documentation can be found
`here <https://codepost-powertools.readthedocs.io/en/latest/>`_.

.. The "Overview" page in the documentation is a more detailed version of the
   below. Note that it does not use it directly, since this file must be PyPi-
   compliant. See:
   https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup

Installation
------------

.. code-block:: bash

   $ pip install codepost-powertools

Usage
-----

Please see the documentation for a more detailed description of the usage.

You should have a dedicated folder for the usage of these tools, since it
requires an input config file and outputs files for certain commands /
functions. It is recommended to use a virtual environment for this:

.. code-block:: bash

   $ python -m venv env
   $ source env/bin/activate
   (env) $ python -m pip install codepost-powertools
   (env) $ cptools --help
   (env) $ python my_script.py

By default, the package will look for a configuration file called
``config.yaml`` that contains a field ``"api_key"`` for your codePost API key.
See
`this page <https://docs.codepost.io/docs#2-obtaining-your-codepost-api-key>`_
for instructions on how to access your codePost API key, as well as more
information on the config YAML file. You must have admin access to all the
courses you wish to access with this package.

Command Line Usage
^^^^^^^^^^^^^^^^^^

You can access the command-line interface with the ``cptools`` command:

.. code-block:: bash

   $ cptools --help

   Usage: cptools [OPTIONS] COMMAND [ARGS]...

     The `codepost_powertools` package on the command line.

Please see the CLI documentation for more information.

Script Usage
^^^^^^^^^^^^

You can import the package in a script:

.. code-block:: python

   import codepost_powertools as cptools
   
   # Log in to codePost
   cptools.log_in_codepost()

   # Call methods

Please see the "Writing Scripts" documentation for more information.