https://github.com/vyahello/newspaper-parser
🗞️ Web tool to parse newspaper resources (python + flask + html/css + travisCI + heroku)
https://github.com/vyahello/newspaper-parser
web-parser
Last synced: 6 months ago
JSON representation
🗞️ Web tool to parse newspaper resources (python + flask + html/css + travisCI + heroku)
- Host: GitHub
- URL: https://github.com/vyahello/newspaper-parser
- Owner: vyahello
- License: mit
- Created: 2020-04-14T16:30:57.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-10T22:46:40.000Z (almost 3 years ago)
- Last Synced: 2025-03-05T18:30:38.329Z (11 months ago)
- Topics: web-parser
- Language: Python
- Homepage: https://newspaper-parser.herokuapp.com
- Size: 24.7 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://www.python.org/)
[](https://travis-ci.org/vyahello/newspaper-parser)
[](https://coveralls.io/github/vyahello/newspaper-parser?branch=master)
[](https://github.com/psf/black)
[](https://www.pylint.org)
[](http://flake8.pycqa.org/)
[](http://www.pydocstyle.org/)
[](http://mypy-lang.org/)
[](LICENSE.md)
[](https://www.elegantobjects.org)
[](https://www.codefactor.io/repository/github/vyahello/newspaper-parser)
# 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](https://flask.palletsprojects.com)
### Development
- [travis](https://travis-ci.org/) CI
- [pytest](https://pypi.org/project/pytest/)
- [black](https://black.readthedocs.io/en/stable/)
- [mypy](http://mypy.readthedocs.io/en/latest)
- [pylint](https://www.pylint.org/)
- [flake8](http://flake8.pycqa.org/en/latest/)
- [pydocstyle](https://github.com/PyCQA/pydocstyle)
## Usage
### Quick start
Please open https://newspaper-parser.herokuapp.com and start using an application.
### Source code
```bash
git clone git@testhome:vyahello/newspaper-parser
python -m article
```
After, please open [0.0.0.0:5001](http://0.0.0.0:5001) endpoint.
**[⬆ back to top](#newspaper-parser)**
## Development notes
### Testing
Generally, `pytest` tool is used to organize testing procedure.
Please follow next command to run unittests:
```bash
pytest
```
### CI
Project has Travis CI integration using [.travis.yml](.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:
```bash
./analyse-source-code.sh
```
### Release notes
Please check [changelog](CHANGELOG.md) file to get more details about actual versions and it's release notes.
### Meta
Author – _Volodymyr Yahello_. Please check [authors](AUTHORS.md) file for more details.
Distributed under the `MIT` license. See [license](LICENSE.md) for more information.
You can reach out me at:
* [vyahello@gmail.com](vyahello@gmail.com)
* [https://twitter.com/vyahello](https://twitter.com/vyahello)
* [https://www.linkedin.com/in/volodymyr-yahello-821746127](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](#newspaper-parser)**