ported vk scraper logic into lib

This commit is contained in:
Miguel Ramalho
2022-06-17 19:15:20 +02:00
parent b3c7ac8e5d
commit 965057619f
32 changed files with 1346 additions and 610 deletions

View File

@@ -17,14 +17,15 @@ from datetime import datetime
#
sys.path.insert(0, os.path.abspath("../../"))
sys.path.insert(0, os.path.abspath("../../vk_url_scraper"))
from my_package.version import VERSION, VERSION_SHORT # noqa: E402
from vk_url_scraper.version import VERSION, VERSION_SHORT # noqa: E402
# -- Project information -----------------------------------------------------
project = "my-package"
copyright = f"{datetime.today().year}, Allen Institute for Artificial Intelligence"
author = "Allen Institute for Artificial Intelligence"
project = "vk-url-scraper"
copyright = f"{datetime.today().year}, Bellingcat"
author = "Bellingcat"
version = VERSION_SHORT
release = VERSION
@@ -82,7 +83,7 @@ typehints_defaults = "comma"
#
html_theme = "furo"
html_title = f"my-package v{VERSION}"
html_title = f"vk-url-scraper v{VERSION}"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
@@ -97,7 +98,7 @@ html_theme_options = {
"footer_icons": [
{
"name": "GitHub",
"url": "https://github.com/allenai/python-package-template",
"url": "https://github.com/bellingcat/vk-url-scraper",
"html": """
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
@@ -108,7 +109,7 @@ html_theme_options = {
],
}
# -- Hack to get rid of stupid warnings from sphinx_autodoc_typehints --------
# -- Hack to get rid of warnings from sphinx_autodoc_typehints --------
class ShutupSphinxAutodocTypehintsFilter(logging.Filter):

View File

@@ -1,12 +1,18 @@
.. my_package documentation master file, created by
.. vk_url_scraper documentation master file, created by
sphinx-quickstart on Tue Sep 21 08:07:48 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
**my-package**
===============
**vk-url-scraper**
==================
.. automodule:: vk_url_scraper
:imported-members:
.. automethod:: __init__
:members:
:undoc-members:
:show-inheritance:
.. automodule:: my_package
Contents
--------
@@ -23,24 +29,22 @@ Contents
:hidden:
:caption: Development
License <https://raw.githubusercontent.com/allenai/python-package-template/main/LICENSE>
License <https://raw.githubusercontent.com/bellingcat/vk-url-scraper/main/LICENSE>
CONTRIBUTING
GitHub Repository <https://github.com/allenai/python-package-template>
GitHub Repository <https://github.com/bellingcat/vk-url-scraper>
Team
----
**my-package** is developed and maintained by the AllenNLP team, backed by
`the Allen Institute for Artificial Intelligence (AI2) <https://allenai.org/>`_.
AI2 is a non-profit institute with the mission to contribute to humanity through high-impact AI research and engineering.
**vk-url-scraper** is developed and maintained by the Bellingcat Tech Team.
To learn more about who specifically contributed to this codebase, see
`our contributors <https://github.com/allenai/python-package-template/graphs/contributors>`_ page.
`our contributors <https://github.com/bellingcat/vk-url-scraper/graphs/contributors>`_ page.
License
-------
**my-package** is licensed under `Apache 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.
A full copy of the license can be found `on GitHub <https://github.com/allenai/python-package-template/blob/main/LICENSE>`_.
**vk-url-scraper** is licensed under the MIT license.
A full copy of the license can be found `on GitHub <https://github.com/bellingcat/vk-url-scraper/blob/main/LICENSE>`_.
Indices and tables
------------------

View File

@@ -1,23 +1,23 @@
Installation
============
**my-package** supports Python >= 3.7.
**vk-url-scraper** supports Python >= 3.7.
## Installing with `pip`
**my-package** is available [on PyPI](https://pypi.org/project/my-package/). Just run
**vk-url-scraper** is available [on PyPI](https://pypi.org/project/vk-url-scraper/). Just run
```bash
pip install my-package
pip install vk-url-scraper
```
## Installing from source
To install **my-package** from source, first clone [the repository](https://github.com/allenai/python-package-template):
To install **vk-url-scraper** from source, first clone [the repository](https://github.com/bellingcat/vk-url-scraper):
```bash
git clone https://github.com/allenai/python-package-template.git
cd python-package-template
git clone https://github.com/bellingcat/vk-url-scraper.git
cd vk-url-scraper
```
Then run