Skip to content

Commit 42ee6e7

Browse files
authored
Merge pull request #120 from uclahs-cds/aholmes-update-name-docs
Update package descriptions and add explanation of name.
2 parents 30025e8 + 5326d37 commit 42ee6e7

17 files changed

+22
-20
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# Boutros Lab Python Libraries [ `Ligare` ]
1+
# `Ligare`
22

3-
A collection of Python libraries for creating web applications, working with databases, writing tests, and supporting utilities.
3+
A collection of Python libraries for creating Python applications quickly.
4+
5+
The word "ligare" (pronounced "lee - gah - reh") means "to bind" or "to tie" - and that is the overall intent of the Ligare framework. Ligare "ties together" many disparate Python functionalities into a single framework from which a variety of applications can be developed. The name is inspired by the Connexion framework, whose own names stems from the word "connection." Ligare supports web applications, console applications, database connectivity, development libraries and tools, and more - all with a common core architecture.
46

57
# Quick Starts
68

metadata.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Category: 'project'
3-
Description: 'A collection of reusable Python libraries developed in Boutros Lab'
3+
Description: 'A framework for quickly developing new Python applications.'
44
Maintainers: ['[email protected]']
55
Contributors: 'Aaron Holmes'
66
Languages: ['python']

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ requires-python = ">=3.10"
1414
authors = [
1515
{name = 'Aaron Holmes', email = '[email protected]'}
1616
]
17-
description = 'Python libraries for use in Boutros Lab.'
17+
description = 'A framework for quickly developing new Python applications.'
1818
classifiers = [
1919
"Programming Language :: Python :: 3",
2020
"License :: OSI Approved :: GNU General Public License (GPL)",

src/AWS/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# `Ligare.AWS`
22

3-
Libraries for working with AWS services in Boutros Lab.
3+
Libraries for working with AWS services.

src/AWS/pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ requires-python = ">=3.10"
1313
authors = [
1414
{name = 'Aaron Holmes', email = '[email protected]'}
1515
]
16-
description = 'Libraries for working with AWS services in Boutros Lab.'
16+
description = 'Libraries for working with AWS services.'
1717
classifiers = [
1818
"Programming Language :: Python :: 3",
1919
"License :: OSI Approved :: GNU General Public License (GPL)",

src/GitHub/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# `Ligare.GitHub`
22

3-
Libraries for working with the GitHub HTTP API in Boutros Lab.
3+
Libraries for working with the GitHub HTTP API.

src/GitHub/pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ requires-python = ">=3.10"
1313
authors = [
1414
{name = 'Aaron Holmes', email = '[email protected]'}
1515
]
16-
description = 'Libraries for working with the GitHub API in Boutros Lab.'
16+
description = 'Libraries for working with the GitHub HTTP API.'
1717
classifiers = [
1818
"Programming Language :: Python :: 3",
1919
"License :: OSI Approved :: GNU General Public License (GPL)",

src/database/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# `Ligare.database`
22

3-
Libraries for working with databases in Boutros Lab.
3+
Libraries for working with databases.
44

55
# SQLite Support
66

77
SQLite support is built into `Ligare.database`.
88

99
# PostgreSQL Support
1010

11-
Install `Ligare.database[postgres]` for production use or `Ligare.database[postgres-binary]` if your machine cannot compile [psycopg2](https://pypi.org/project/psycopg2/).
11+
Install `Ligare.database[postgres]` for production use or `Ligare.database[postgres-binary]` if your machine cannot compile [psycopg2](https://pypi.org/project/psycopg2/).

src/database/pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ requires-python = ">=3.10"
1313
authors = [
1414
{name = 'Aaron Holmes', email = '[email protected]'}
1515
]
16-
description = 'Libraries for working with databases in Boutros Lab.'
16+
description = 'Libraries for working with databases.'
1717
classifiers = [
1818
"Programming Language :: Python :: 3",
1919
"License :: OSI Approved :: GNU General Public License (GPL)",

src/identity/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# `Ligare.identity`
22

3-
Libraries for working with identity and SSO in Boutros Lab.
3+
Libraries for working with identity and SSO.

src/identity/pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ requires-python = ">=3.10"
1313
authors = [
1414
{name = 'Aaron Holmes', email = '[email protected]'}
1515
]
16-
description = 'Libraries for building web applications in Boutros Lab.'
16+
description = 'Libraries for working with identity and SSO.'
1717
classifiers = [
1818
"Programming Language :: Python :: 3",
1919
"License :: OSI Approved :: GNU General Public License (GPL)",

src/platform/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# `Ligare.platform`
22

3-
Libraries for developing PaaS software in Boutros Lab.
3+
Libraries for developing PaaS software.
44

55
# `Ligare` Development Dependencies
66

77
During development of `Ligare.platform`, you may need to explicitly install other `Ligare` dependencies.
88

99
If developing from the root repository, install with:
10-
- `pip install -e src/database`
10+
- `pip install -e src/database`

src/platform/pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ requires-python = ">=3.10"
1313
authors = [
1414
{name = 'Aaron Holmes', email = '[email protected]'}
1515
]
16-
description = 'Libraries for developing PaaS software in Boutros Lab.'
16+
description = 'Libraries for developing PaaS software.'
1717
classifiers = [
1818
"Programming Language :: Python :: 3",
1919
"License :: OSI Approved :: GNU General Public License (GPL)",

src/programming/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# `Ligare.programming`
22

3-
Libraries for writing software in Boutros Lab.
3+
Libraries for writing software.

src/programming/pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ requires-python = ">=3.10"
1313
authors = [
1414
{name = 'Aaron Holmes', email = '[email protected]'}
1515
]
16-
description = 'Libraries for writing software in Boutros Lab.'
16+
description = 'Libraries for writing software.'
1717
classifiers = [
1818
"Programming Language :: Python :: 3",
1919
"License :: OSI Approved :: GNU General Public License (GPL)",

src/web/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `Ligare.web`
22

3-
Libraries for building web applications in Boutros Lab.
3+
Libraries for building web applications.
44

55
# Quick Start
66

src/web/pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ requires-python = ">=3.10"
1313
authors = [
1414
{name = 'Aaron Holmes', email = '[email protected]'}
1515
]
16-
description = 'Libraries for building web applications in Boutros Lab.'
16+
description = 'Libraries for building web applications.'
1717
classifiers = [
1818
"Programming Language :: Python :: 3",
1919
"License :: OSI Approved :: GNU General Public License (GPL)",

0 commit comments

Comments
 (0)