Skip to content

Commit

Permalink
Merge pull request #120 from uclahs-cds/aholmes-update-name-docs
Browse files Browse the repository at this point in the history
Update package descriptions and add explanation of name.
  • Loading branch information
aholmes authored Sep 24, 2024
2 parents 30025e8 + 5326d37 commit 42ee6e7
Show file tree
Hide file tree
Showing 17 changed files with 22 additions and 20 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Boutros Lab Python Libraries [ `Ligare` ]
# `Ligare`

A collection of Python libraries for creating web applications, working with databases, writing tests, and supporting utilities.
A collection of Python libraries for creating Python applications quickly.

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.

# Quick Starts

Expand Down
2 changes: 1 addition & 1 deletion metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
Category: 'project'
Description: 'A collection of reusable Python libraries developed in Boutros Lab'
Description: 'A framework for quickly developing new Python applications.'
Maintainers: ['[email protected]']
Contributors: 'Aaron Holmes'
Languages: ['python']
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ requires-python = ">=3.10"
authors = [
{name = 'Aaron Holmes', email = '[email protected]'}
]
description = 'Python libraries for use in Boutros Lab.'
description = 'A framework for quickly developing new Python applications.'
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: GNU General Public License (GPL)",
Expand Down
2 changes: 1 addition & 1 deletion src/AWS/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# `Ligare.AWS`

Libraries for working with AWS services in Boutros Lab.
Libraries for working with AWS services.
2 changes: 1 addition & 1 deletion src/AWS/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ requires-python = ">=3.10"
authors = [
{name = 'Aaron Holmes', email = '[email protected]'}
]
description = 'Libraries for working with AWS services in Boutros Lab.'
description = 'Libraries for working with AWS services.'
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: GNU General Public License (GPL)",
Expand Down
2 changes: 1 addition & 1 deletion src/GitHub/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# `Ligare.GitHub`

Libraries for working with the GitHub HTTP API in Boutros Lab.
Libraries for working with the GitHub HTTP API.
2 changes: 1 addition & 1 deletion src/GitHub/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ requires-python = ">=3.10"
authors = [
{name = 'Aaron Holmes', email = '[email protected]'}
]
description = 'Libraries for working with the GitHub API in Boutros Lab.'
description = 'Libraries for working with the GitHub HTTP API.'
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: GNU General Public License (GPL)",
Expand Down
4 changes: 2 additions & 2 deletions src/database/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# `Ligare.database`

Libraries for working with databases in Boutros Lab.
Libraries for working with databases.

# SQLite Support

SQLite support is built into `Ligare.database`.

# PostgreSQL Support

Install `Ligare.database[postgres]` for production use or `Ligare.database[postgres-binary]` if your machine cannot compile [psycopg2](https://pypi.org/project/psycopg2/).
Install `Ligare.database[postgres]` for production use or `Ligare.database[postgres-binary]` if your machine cannot compile [psycopg2](https://pypi.org/project/psycopg2/).
2 changes: 1 addition & 1 deletion src/database/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ requires-python = ">=3.10"
authors = [
{name = 'Aaron Holmes', email = '[email protected]'}
]
description = 'Libraries for working with databases in Boutros Lab.'
description = 'Libraries for working with databases.'
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: GNU General Public License (GPL)",
Expand Down
2 changes: 1 addition & 1 deletion src/identity/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# `Ligare.identity`

Libraries for working with identity and SSO in Boutros Lab.
Libraries for working with identity and SSO.
2 changes: 1 addition & 1 deletion src/identity/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ requires-python = ">=3.10"
authors = [
{name = 'Aaron Holmes', email = '[email protected]'}
]
description = 'Libraries for building web applications in Boutros Lab.'
description = 'Libraries for working with identity and SSO.'
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: GNU General Public License (GPL)",
Expand Down
4 changes: 2 additions & 2 deletions src/platform/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# `Ligare.platform`

Libraries for developing PaaS software in Boutros Lab.
Libraries for developing PaaS software.

# `Ligare` Development Dependencies

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

If developing from the root repository, install with:
- `pip install -e src/database`
- `pip install -e src/database`
2 changes: 1 addition & 1 deletion src/platform/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ requires-python = ">=3.10"
authors = [
{name = 'Aaron Holmes', email = '[email protected]'}
]
description = 'Libraries for developing PaaS software in Boutros Lab.'
description = 'Libraries for developing PaaS software.'
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: GNU General Public License (GPL)",
Expand Down
2 changes: 1 addition & 1 deletion src/programming/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# `Ligare.programming`

Libraries for writing software in Boutros Lab.
Libraries for writing software.
2 changes: 1 addition & 1 deletion src/programming/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ requires-python = ">=3.10"
authors = [
{name = 'Aaron Holmes', email = '[email protected]'}
]
description = 'Libraries for writing software in Boutros Lab.'
description = 'Libraries for writing software.'
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: GNU General Public License (GPL)",
Expand Down
2 changes: 1 addition & 1 deletion src/web/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `Ligare.web`

Libraries for building web applications in Boutros Lab.
Libraries for building web applications.

# Quick Start

Expand Down
2 changes: 1 addition & 1 deletion src/web/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ requires-python = ">=3.10"
authors = [
{name = 'Aaron Holmes', email = '[email protected]'}
]
description = 'Libraries for building web applications in Boutros Lab.'
description = 'Libraries for building web applications.'
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: GNU General Public License (GPL)",
Expand Down

0 comments on commit 42ee6e7

Please sign in to comment.