Merge pull request #19 from idle-org/releases/1.0.1

Releases/1.0.1
This commit is contained in:
Vicky 2022-06-15 19:50:05 +02:00 committed by GitHub
commit 53455e8ec2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 17 additions and 35 deletions

View File

@ -5,9 +5,9 @@ name: Python Tests and Lint
on:
push:
branches: [ main, test ]
branches: [ main, release, releases/*]
pull_request:
branches: [ main, test ]
branches: [ main, release, releases/* ]
jobs:
@ -40,23 +40,3 @@ jobs:
- name: Test with pytest
run: |
pytest --cov-fail-under=100 -o xfail_strict=true --cov-report=term-missing .
# deployment:
# runs-on: ubuntu-latest
# environment: production
# steps:
# - uses: actions/checkout@v2
# - name: Set up Python 3.10
# uses: actions/setup-python@v2
# with:
# python-version: "3.10"
# - name: Build the application
# run: |
# python -m pip install --upgrade pip
# pip install -r requirements.txt
# pip install -e .
# python -m bootstraparse "example_userfiles" "docs"
# - name: deploy
# uses: JamesIves/github-pages-deploy-action@v4.3.3
# with:
# branch: gh-pages # The branch the action should deploy to.
# folder: docs

View File

@ -5,23 +5,27 @@ bootstraparse aims to be customisable in that regard, but its first iteration an
You can refer to the `example_userfiles` for an idea of what the parser expects you to feed it and find an example of our automated generation at https://idle-org.github.io/bootstraparse/ for this particular folder. Or you can run the program yourself for the same result!
[![Python application](https://github.com/idle-org/bootstraparse/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/idle-org/bootstraparse/actions/workflows/python-app.yml)
- Main
- [![Python Main](https://github.com/idle-org/bootstraparse/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/idle-org/bootstraparse/actions/workflows/python-app.yml)
- Releases
- [![Python Release](https://github.com/idle-org/bootstraparse/actions/workflows/python-app.yml/badge.svg?branch=release)](https://github.com/idle-org/bootstraparse/actions/workflows/python-app.yml)
---
## Roadmap
## Release Notes
### V1.0.1
- Make the default example site way more useful ☐
- Add the type and return types of all functions ☑
- Add documentation to remaining lone functions ☑
- Write a documentation for the application (use specs.yaml) ☐
- Remove old regex usage
- Add copy behaviour to config file
- Add the type and return types of all functions
- Add documentation to remaining lone functions
- Copy un-parsable files to destination folder without modifications
- Many bug fixes and improvements
## Roadmap
### V1.0.2
- Make the default example site way more useful ☐
- Write a documentation for the application (use specs.yaml) ☐
- Move the WARNING-level output to INFO for config overwrite ☐
### V1.0.3
- Copy un-parsable files to destination folder without modifications ☑
- Add copy behaviour to config file ☑
### V1.1
- Functioning `table` Token ☐
- Functioning `code` Token ☐
@ -33,7 +37,6 @@ You can refer to the `example_userfiles` for an idea of what the parser expects
### V1.2
- Check error messages and add a real debug level to parameters ☐
- Functioning `blockquote` Token ☐
- Remove old regex usage ☑
### V1.3
- Add advanced lookahead logic for `*` ☐

View File

@ -5,4 +5,3 @@ pytest-cov==3.0.0
mypy==0.941
pyyaml==6.0
rich==12.0.1
regex==2022.3.15

View File

@ -2,7 +2,7 @@
name = bootstraparse
description = A custom markdown parser for Bootstrap & Python
author = Vkyfox
version = 1.0
version = 1.0.1
license = Mozilla Public License Version 2.0
license_file = LICENSE
platforms = unix, linux, osx, cygwin, win32