bellingcat/vk-url-scraper
1
0
Fork 0
mirror of https://github.com/bellingcat/vk-url-scraper.git synced 2026-06-12 21:38:36 +03:00
Code Issues Packages Projects Releases Wiki Activity

attempts to circumvent pypi not allowing repo reference

Browse Source
This commit is contained in:
msramalho
2024-07-16 16:18:23 +01:00
parent 5d30d18b7b
commit 9c7eadc716
2 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -12,6 +12,9 @@ You can use it via the [command line](#command-line-usage) or as a [python libra
## Installation ## Installation
You can install the most recent release from [pypi](https://pypi.org/project/vk-url-scraper/) via `pip install vk-url-scraper`. You can install the most recent release from [pypi](https://pypi.org/project/vk-url-scraper/) via `pip install vk-url-scraper`.
Currently you need to manually install one dependency (as it is installed from github and not pypi):
`pip install git+https://github.com/python273/vk_api.git@b99dac0ec2f832a6c4b20bde49869e7229ce4742`
To use the library you will need a valid username/password combination for vk.com. To use the library you will need a valid username/password combination for vk.com.
## Command line usage ## Command line usage
@@ -98,6 +101,7 @@ To test the command line interface available in [__main__.py](__vk_url_scraper/_
## Releasing new version ## Releasing new version
1. edit [version.py](vk_url_scraper/version.py) with proper versioning 1. edit [version.py](vk_url_scraper/version.py) with proper versioning
2. make sure to run `pipenv run pip freeze > requirements.txt` if you manage libs with pipenv 2. make sure to run `pipenv run pip freeze > requirements.txt` if you manage libs with pipenv
1. if the hardcoded version of [vk_api](https://github.com/python273/vk_api) is still being used, then you must comment/remove that line from the generated requirements file and instruct users to manually install the version from the source as pypi does not allow repo/commit tags. Additionally, add the latest released version, currently `vk-api==11.9.9`.
3. run `./scripts/release.sh` to create a tag and push, alternatively 3. run `./scripts/release.sh` to create a tag and push, alternatively
1. `git tag vx.y.z` to tag version 1. `git tag vx.y.z` to tag version
2. `git push origin vx.y.z` -> this will trigger workflow and put project on [pypi](https://pypi.org/project/vk-url-scraper/) 2. `git push origin vx.y.z` -> this will trigger workflow and put project on [pypi](https://pypi.org/project/vk-url-scraper/)

3
requirements.txt
View File

@@ -94,7 +94,8 @@ twine==5.1.1
typing_extensions==4.12.2 typing_extensions==4.12.2
urllib3==2.2.2 urllib3==2.2.2
uvicorn==0.30.1 uvicorn==0.30.1
vk-api @ git+https://github.com/python273/vk_api.git@b99dac0ec2f832a6c4b20bde49869e7229ce4742 # vk-api @ git+https://github.com/python273/vk_api.git@b99dac0ec2f832a6c4b20bde49869e7229ce4742
vk-api==11.9.9
watchfiles==0.22.0 watchfiles==0.22.0
webencodings==0.5.1 webencodings==0.5.1
websockets==12.0 websockets==12.0