Skip to content

Commit fff34a1

Browse files
adamhmetalAdam Puza
adamhmetal
and
Adam Puza
authored
Fixes documentation (#3)
Co-authored-by: Adam Puza <adam.puza@gmail.com>
1 parent 687930b commit fff34a1

32 files changed

Lines changed: 100 additions & 73 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ The idea of RedBeanPython ORM is to decrease the time to market for applications
88

99
RedBeanPython ORM's idea is not to replace the more advanced ORMs (we should not reinvent the wheel) but to cooperate with them. Initially, it can be used as only ORM. When projects evolve, both code bases (RedBeanPython and SQLAlchemy) can coexist and, finally, can be swiftly replaced by SQLAlchemy (if needed).
1010

11-
![Tests on PostgreSQL](https://github.com/adamhmetal/redbeanpythondev/actions/workflows/test_postgres.yml/badge.svg)
12-
![Tests on MySQL](https://github.com/adamhmetal/redbeanpythondev/actions/workflows/test_mysql.yml/badge.svg)
13-
![Tests on SQLite](https://github.com/adamhmetal/redbeanpythondev/actions/workflows/test_sqlite.yml/badge.svg)
14-
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=coverage)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
15-
16-
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
17-
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
18-
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
11+
![Tests on PostgreSQL](https://github.com/adamhmetal/redbeanpython/actions/workflows/test_postgres.yml/badge.svg)
12+
![Tests on MySQL](https://github.com/adamhmetal/redbeanpython/actions/workflows/test_mysql.yml/badge.svg)
13+
![Tests on SQLite](https://github.com/adamhmetal/redbeanpython/actions/workflows/test_sqlite.yml/badge.svg)
14+
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=coverage)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
15+
16+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
17+
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
18+
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
1919

2020

2121
# Installation

‎dist/redbeanpython-1.0.0-py3-none-any.whl‎

30.4 KB
Binary file not shown.

‎dist/redbeanpython-1.0.0.tar.gz‎

24.6 KB
Binary file not shown.

‎docs/changelog.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Changelog
22

3+
## 1.0.1
4+
5+
2021-02-04
6+
7+
Documentation fixes.
8+
39
## 1.0.0
410

511
2021-02-01

‎docs/index.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ RedBeanPython idea is inspired by the matured [RedBeanPHP ORM](https://www.redbe
1111

1212
RedBeanPython ORM's idea is not to replace the more advanced ORMs (we should not reinvent the wheel) but to cooperate with them. Initially, it can be used as only ORM. When projects evolve, both code bases (RedBeanPython and SQLAlchemy) can coexist and, finally, can be swiftly replaced by SQLAlchemy (if needed).
1313

14-
![Tests on PostgreSQL](https://github.com/adamhmetal/redbeanpythondev/actions/workflows/test_postgres.yml/badge.svg)
15-
![Tests on MySQL](https://github.com/adamhmetal/redbeanpythondev/actions/workflows/test_mysql.yml/badge.svg)
16-
![Tests on SQLite](https://github.com/adamhmetal/redbeanpythondev/actions/workflows/test_sqlite.yml/badge.svg)
17-
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=coverage)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
18-
19-
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
20-
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
21-
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
14+
![Tests on PostgreSQL](https://github.com/adamhmetal/redbeanpython/actions/workflows/test_postgres.yml/badge.svg)
15+
![Tests on MySQL](https://github.com/adamhmetal/redbeanpython/actions/workflows/test_mysql.yml/badge.svg)
16+
![Tests on SQLite](https://github.com/adamhmetal/redbeanpython/actions/workflows/test_sqlite.yml/badge.svg)
17+
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=coverage)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
18+
19+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
20+
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
21+
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
2222

2323

2424
## Let's see an example of a usual project lifecycle.

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
44

55
[tool.poetry]
66
name = "redbeanpython"
7-
version = "1.0.0"
7+
version = "1.0.1"
88
description = "RedBeanPython ORM"
99
authors = ["Adam Puza <adampuza@redbeanpython.org>"]
1010
readme = "README.md"

‎site/404.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717

1818
<link rel="icon" href="/assets/favicon.png">
19-
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.5">
19+
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.6">
2020

2121

2222

@@ -956,7 +956,7 @@ <h1>404 - Not found</h1>
956956
<script id="__config" type="application/json">{"base": "/", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.expand"], "search": "/assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
957957

958958

959-
<script src="/assets/javascripts/bundle.c18c5fb9.min.js"></script>
959+
<script src="/assets/javascripts/bundle.e1c3ead8.min.js"></script>
960960

961961

962962
</body>

site/assets/javascripts/bundle.c18c5fb9.min.js renamed to site/assets/javascripts/bundle.e1c3ead8.min.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

site/assets/javascripts/bundle.c18c5fb9.min.js.map renamed to site/assets/javascripts/bundle.e1c3ead8.min.js.map

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎site/beans/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323

2424
<link rel="icon" href="../assets/favicon.png">
25-
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.5">
25+
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.6">
2626

2727

2828

@@ -1181,7 +1181,7 @@ <h1 id="___">___</h1>
11811181
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.expand"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
11821182

11831183

1184-
<script src="../assets/javascripts/bundle.c18c5fb9.min.js"></script>
1184+
<script src="../assets/javascripts/bundle.e1c3ead8.min.js"></script>
11851185

11861186

11871187
</body>

0 commit comments

Comments
 (0)