cleanup

.github/pull_request_template.md

@@ -10,7 +10,7 @@ Changes proposed in this pull request:
 ## Before submitting
 
 <!-- Please complete this checklist BEFORE submitting your PR to speed along the review process. -->
-- [ ] I've read and followed all steps in the [Making a pull request](https://github.com/bellingcat/vk-url-scraper/blob/main/CONTRIBUTING.md#making-a-pull-request)
+- [ ] I've read and followed all steps in the [Making a pull request](https://github.com/bellingcat/vk-url-scraper/blob/main/CONTRIBUTING.md#making-a-pull-request) 
     section of the `CONTRIBUTING` docs.
 - [ ] I've updated or added any relevant docstrings following the syntax described in the
     [Writing docstrings](https://github.com/bellingcat/vk-url-scraper/blob/main/CONTRIBUTING.md#writing-docstrings) section of the `CONTRIBUTING` docs.

.github/workflows/main.yml

@@ -121,10 +121,6 @@ jobs:
           name: package
           path: dist
 
-      # - name: Generate release notes
-      #   run: |
-      #     python scripts/release_notes.py > ${{ github.workspace }}-RELEASE_NOTES.md
-
       - name: Publish package to PyPI
         run: |
           twine upload -u '${{ secrets.PYPI_USERNAME }}' -p '${{ secrets.PYPI_PASSWORD }}' dist/*

CONTRIBUTING.md

@@ -156,8 +156,6 @@ When you're ready to contribute code to address an open issue, please follow the
 
     If the build fails, it's most likely due to small formatting issues. If the error message isn't clear, feel free to comment on this in your pull request.
 
-    And finally, please update the [CHANGELOG](https://github.com/bellingcat/vk-url-scraper/blob/main/CHANGELOG.md) with notes on your contribution in the "Unreleased" section at the top.
-
     After all of the above checks have passed, you can now open [a new GitHub pull request](https://github.com/bellingcat/vk-url-scraper/pulls).
     Make sure you have a clear description of the problem and the solution, and include a link to relevant issues.
 

README.md

@@ -2,10 +2,7 @@
 Library to scrape data and especially media links (videos and photos) from vk.com URLs.
 
 
-# TODO
-* docs online from sphinx
-
-## Quick usage
+## Quick usage API
 `pip install vk-url-scraper` to install.
 
 
@@ -43,15 +40,32 @@ print(res[0]["text]) # eg: -> to get the text from code
 
 see [docs] for all available functions. 
 
-### Development
+### TODO
+* docs online from sphinx
+
+## Development
+(more info in [CONTRIBUTING.md](CONTRIBUTING.md)).
+
+1. setup dev environment with `pip install -r dev-requirements` or `pipenv install -r dev-requirements`
 1. setup environment with `pip install -r requirements` or `pipenv install -r requirements`
 2. To run all checks to `make run-checks` (fixes style) or individually
    1. To fix style: `black .` and `isort .` -> `flake8 .` to validate lint
    2. To do type checking: `mypy .`
    3. To test: `pytest .` (`pytest -v --color=yes --doctest-modules tests/ vk_url_scraper/` to user verbose, colors, and test docstring examples)
 3. `make docs` to generate shpynx docs -> edit [config.py](docs/source/conf.py) if needed
 
-### Releasing new version
+## Releasing new version
 1. edit [version.py](vk_url_scraper/version.py) with proper versioning
-2. `git tag vx.y.z` to tag version
-3. `git push origin vx.y.z` -> this will trigger workflow and put project on [pypi](https://pypi.org/project/vk-url-scraper/)
+2. run `./scripts/release.sh` to create a tag and push, alternatively
+   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/)
+
+### Fixing a failed release
+
+If for some reason the GitHub Actions release workflow failed with an error that needs to be fixed, you'll have to delete both the tag and corresponding release from GitHub. After you've pushed a fix, delete the tag from your local clone with
+
+```bash
+git tag -l | xargs git tag -d && git fetch -t
+```
+
+Then repeat the steps above.

docs/source/index.rst

@@ -23,7 +23,6 @@ Contents
 
    installation
    overview
-   CHANGELOG
 
 .. toctree::
    :hidden:

scripts/release.sh

@@ -7,7 +7,6 @@ TAG=$(python -c 'from vk_url_scraper.version import VERSION; print("v" + VERSION
 read -p "Creating new release for $TAG. Do you want to continue? [Y/n] " prompt
 
 if [[ $prompt == "y" || $prompt == "Y" || $prompt == "yes" || $prompt == "Yes" ]]; then
-    python scripts/prepare_changelog.py
     git add -A
     git commit -m "Bump version to $TAG for release" || true && git push
     echo "Creating new git tag $TAG"