The Cython-Optimized Plugin Oriented Programming System
Project description
cPop is used to express the Plugin Oriented Programming Paradigm. The Plugin Oriented Programming Paradigm has been designed to make pluggable software easy to write and easy to extend.
Plugin Oriented Programming presents a new way to scale development teams and deliver complex software. This is done by making the applications entirely out of plugins, and also making the applications themselves natively pluggable with each other.
Using Plugin Oriented Programming it then becomes easy to have the best of both worlds, software can be built in small pieces, making development easier to maintain. The small pieces can then be merged and deployed in a single binary, making code deployment easy as well.
All this using Cython, one of the world’s most popular and powerful programming languages.
Getting Started
First off, install cPop from pypi:
pip3 install cPopNow all it takes to create a pluggable application is a few lines of code. This is the root of every pop project. We create a hub, we add dynamic subsystems, and then we call them through the hub’s namespace.
import pop.hub
import asyncio
loop = asyncio.get_event_loop()
asyncio.run(main())
async def main():
hub = await pop.hub.AsyncHub()
await hub.my_sub.init.cli()You can also initialize pop from the cli:
python -m hub my_sub.init.clior:
hub my_sub.init.cliSpecify a namespace that should host the authoritative CLI by calling using –cli as the first argument:
hub --cli=my_app my_sub.init.cliIf you don’t specify a –cli, unknown args will be forwarded as parameters to the reference you give:
hub pop.test.func arg1 arg2 --kwarg1=asdf --kwarg2 asdfYou can access anything that is on the hub, this is very useful for debugging.
Try this to see the subs that made it onto the hub:
hub _subsYou can do this to see everything that made it into hub.OPT:
hub OPTStart an interactive python shell that includes a hub and allows async code to be run:
hub -i
#>>> await hub.lib.asyncio.sleep(0)When creating a cpop app, we put all of the pop configuration in a config.yaml
# Every config option for your plugin
config:
my_namespace:
my_opt:
default: True
# Options that should be exposed on the CLI when your app controls the CLI
cli_config:
my_namespace:
my_opt:
# All options that are accepted by ArgParser.add_argument are good here
help: description of this option
subcommands:
- my_subcommand
group: My arg group
# Subcommands to expose for your project
subcommands:
my_namespace:
my_subcommand:
help: My subcommand
# Dynamic namespaces that your app merges onto and which folders extend those namespaces
dyne:
my_dyne:
- src_dir
# python imports that your app uses which should be added to hub.lib for your app
import:
- asyncio
- importlib
- importlib.resources
- os
- tomlCreate a pop config file:
# The default location is in ~/.pop/config.yaml
# But you can change that by setting the POP_CONFIG environment variable
pop_cli:
# Setting this option will make your hub persist on the cli between calls
hub_state: ~/.pop/hub.pkl
log:
log_plugin: asyncFrom the above example, all arguments would be loaded onto the namespace under hub.OPT.my_namesapce. One config.yaml can add config options to multiple namespaces. They are all merged together in the order they are found in sys.path
Testing
Clone the repo
git clone https://gitlab.com/Akm0d/cpop.git
cd cpopInstall cpop with the testing extras
pip3 install .\[test\]Run the tests in your cloned fork of cPop:
pytest testsRelease
The following steps are how to release a project with hatch
pip install .\[build\]
hatch build
export HATCH_INDEX_USER="__token__"
export HATCH_INDEX_AUTH="pypi-api-token"
hatch publishDocumentation
Check out the docs for more information:
There is a much more in depth tutorial here, followed by documents on how to think in Plugin Oriented Programming. Take your time to read it, it is not long and can change how you look at writing software!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file cpop-31.0.0.tar.gz.
File metadata
- Download URL: cpop-31.0.0.tar.gz
- Upload date:
- Size: 43.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.27.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a1856922f9cfce04cb8883f8c0e90472385fe04fb9cf547bd58645220e54fa4e |
|
| MD5 | 44195c2418569572fb67724e68649473 |
|
| BLAKE2b-256 | 92a754372d07da0ff76093ea9a6b313f26effae951c9f2b39cba062cec28199d |
File details
Details for the file cpop-31.0.0-cp311-cp311-manylinux_2_39_x86_64.whl.
File metadata
- Download URL: cpop-31.0.0-cp311-cp311-manylinux_2_39_x86_64.whl
- Upload date:
- Size: 782.0 kB
- Tags: CPython 3.11, manylinux: glibc 2.39+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.27.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 17f503067259211270138bb022c8b473239843ffbb68ffe43c278ae02afb4f56 |
|
| MD5 | b1005f44cae5d2d2d10dd229f99ecd63 |
|
| BLAKE2b-256 | e0ce9a2d430acb17d91d463ac1d2b3c85dacd2488082fc6a05609f9da1635673 |
