README

pyhwp
=====

HWP Document Format v5 parser & processor.

Features
--------

- Analyze and extract internal streams out from a HWP Document Format v5 file
- (*Experimental*) Conversion to OpenDocument format (.odt) or plain text (.txt)

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

from `pypi <http://pypi.org/project/pyhwp>`_::

   virtualenv pyhwp
   pyhwp/bin/pip install --pre pyhwp  # Install pyhwp into a virtualenv directory

Or::

   pip install --user --pre pyhwp  # Install pyhwp into user's home directory

Requirements
------------

- Python 2.7, 3.5, 3.6, 3.7 or 3.8
- `cryptography <https://pypi.org/project/cryptography>`_
- `lxml <https://pypi.org/project/lxml>`_
- `olefile <https://pypi.org/project/olefile>`_

Documentation & Development
---------------------------

- Documentation: `https://pyhwp.readthedocs.io <https://pyhwp.readthedocs.io>`_ [`한국/조선어 <https://pyhwp.readthedocs.io/ko/latest>`_]
- Distribution: `https://pypi.org/project/pyhwp/ <https://pypi.org/project/pyhwp/>`_
- Development: `https://github.com/mete0r/pyhwp <https://github.com/mete0r/pyhwp>`_
- Issue tracker: `https://github.com/mete0r/pyhwp/issues <https://github.com/mete0r/pyhwp/issues>`_
- Feedbacks & contributions are welcome!

Contributors
------------

Maintainer: `mete0r <https://github.com/mete0r>`_

License
-------

Copyright (C) 2010-2020 mete0r <https://github.com/mete0r>

.. image:: http://www.gnu.org/graphics/agplv3-155x51.png

`GNU Affero General Public License v3.0 <http://www.gnu.org/licenses/agpl-3.0.html>`_
`(text version) <http://www.gnu.org/licenses/agpl-3.0.txt>`_

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Disclosure
----------

This program has been developed in accordance with a public document named "HWP
Binary Specification 1.1" published by `Hancom Inc. <http://www.hancom.co.kr>`_