Ever finished writing a long microsoft word document that refuses to open once saved and closed? When you try opening the file all you get is a dialog telling you the file is corrupt/broken, leaving you with no option but to start over from scratch.
This tool tries to extract the text in files like that so that you do not have to start typing it from sctratch. Instead you get all the ext you typed in and only have to format it again in your favourite text editor.
Currently the project has one dependecy, Python Fire, a tool by google which handles the tool's commandline interface (This will change in the future as the intention is to use the argparse internal module instead).
- Python3
For development purposes, the project is best run in a virtual environment. Pipenv is the project's choice but you can use python's inbuilt venv module if you wish.
- To install pipenv in Debian based OS's
$ sudo apt install pipenv- To install pipenv in Windows command prompt
pip install pipenv- For instructions on other platforms see Pipenv's documentation.
To get started with this project clone the repo and navigate into it.
- Installing requirements:
pipenv install- Activating virtual environment
pipenv shellNot production ready yet. Installation instructions will come after a Graphical User Interface is added.
Easiest way to use the tool after activating the virtual environment is to run,
python xtractorWhich will initiate the tool in interactive mode.
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Twitter - moran__tz
Email - [email protected]
Project Link - https://github.com/your_username/xtractor