Newspaper parser

A sample web tool to parse given newspaper resources.

Please check https://newspaper-parser.herokuapp.com to get familiar with an application.

Note: please take into account that it is built for demo purpose but not for actual usage.

Tools

Production

• python 3.6, 3.7, 3.8
• flask

Development

• travis CI
• pytest
• black
• mypy
• pylint
• flake8
• pydocstyle

Usage

Quick start

Please open https://newspaper-parser.herokuapp.com and start using an application.

Source code

git clone git@testhome:vyahello/newspaper-parser
python -m article

After, please open 0.0.0.0:5001 endpoint.

⬆ back to top

Development notes

Testing

Generally, pytest tool is used to organize testing procedure.

Please follow next command to run unittests:

pytest

CI

Project has Travis CI integration using .travis.yml file thus code analysis (black, pylint, flake8, mypy, pydocstyle) and unittests (pytest) will be run automatically after every made change to the repository.

To be able to run code analysis, please execute command below:

./analyse-source-code.sh

Release notes

Please check changelog file to get more details about actual versions and it's release notes.

Meta

Author – Volodymyr Yahello. Please check authors file for more details.

Distributed under the MIT license. See license for more information.

You can reach out me at:

• vyahello@gmail.com
• https://twitter.com/vyahello
• https://www.linkedin.com/in/volodymyr-yahello-821746127

Contributing

1. clone the repository
2. configure Git for the first time after cloning with your name and email
3. pip install -r requirements.txt to install all project dependencies
4. pip install -r requirements-dev.txt to install all development project dependencies

⬆ back to top