Metadata-Version: 2.1
Name: paperparser
Version: 0.1.0
Summary: A tool for parsing academic papers
Home-page: https://gitlab.com/winderresearch/tools/PaperParser
License: MIT
Author: Phil Winder
Author-email: phil@WinderResearch.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: PyYAML (>=5.3,<6.0)
Requires-Dist: click (>=7.0,<8.0)
Requires-Dist: desert (>=2020.1.6,<2021.0.0)
Requires-Dist: importlib-metadata (>=1.5.0,<2.0.0); python_version < "3.8"
Requires-Dist: marshmallow (>=3.3.0,<4.0.0)
Requires-Dist: pybtex (>=0.22.2,<0.23.0)
Requires-Dist: pyquery (>=1.4.1,<2.0.0)
Requires-Dist: requests (>=2.22.0,<3.0.0)
Project-URL: Documentation, https://gitlab.com/winderresearch/tools/PaperParser
Project-URL: Repository, https://gitlab.com/winderresearch/tools/PaperParser
Description-Content-Type: text/markdown

# PaperParser

## Installing Python and Poetry

Install pyenv:

```bash
brew install pyenv
brew install pyenv-virtualenv
```

Add the following lines to your `~/.bashrc` or `~/.zshrc`:

```bash
export PATH="~/.pyenv/bin:$PATH"
eval "$(pyenv init -)"
eval "$(pyenv virtualenv-init -)"
```

Install different python versions:

```bash
pyenv install 3.8.1
pyenv install 3.7.6
pyenv local 3.8.1 3.7.6
python3 --version
python3.7 --version
```

Install poetry:

```bash
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
```

Add the following lines to your `~/.bashrc` or `~/.zshrc`:

```bash
source ~/.poetry/env
```

## Installing and Opening in VSCode

```bash
poetry install
poetry shell
code .
```

The select the python interpreter with the project name in.

## Updating Dependencies

```bash
poetry update
```

## Tests

```
nox -k "3.8"
```

## Credits

Heavily inspired by [hypermodern-python](https://github.com/cjolowicz/hypermodern-python) by [cjolowicz](https://github.com/cjolowicz)

