Data

Tools

Indexes

Applications

Experiments

Open Source Science

protean

Pragmatic Framework for Ambitious Applications

https://github.com/proteanhq/protean

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.6%) to scientific vocabulary

Keywords

cqrs domain-driven-design framework ports-and-adapters python
Last synced: 6 months ago · JSON representation

Repository

Pragmatic Framework for Ambitious Applications

Basic Info
  • Host: GitHub
  • Owner: proteanhq
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage: https://docs.proteanhq.com/
  • Size: 7.73 MB
Statistics
  • Stars: 32
  • Watchers: 9
  • Forks: 33
  • Open Issues: 17
  • Releases: 39
Topics
cqrs domain-driven-design framework ports-and-adapters python
Created over 7 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct

README.md

Protean

Protean is an opinionated and pragmatic framework for building event-driven applications using the CQRS pattern.

Python Release Build Status Coverage

Installation

Protean is available on PyPI:

console $ python -m pip install protean Collecting protean Downloading protean-0.13.0-py3-none-any.whl.metadata (5.9 kB) ... Installing collected packages: ... Successfully installed ...

Protean officially supports Python 3.11+.

Quick Start

```python from protean import Domain from protean.fields import String, Text

domain = Domain(name="Publishing")

@domain.aggregate class Post: title = String(required=True, maxlength=1000) slug = String(required=True, maxlength=1024) content = Text(required=True)

domain.init() with domain.domain_context(): post = Post( title="Hello World", slug="hello-world", content="Lorem Ipsum ..." )

domain.repository_for(Post).add(post)

```

Documentation

Online docs are available at https://docs.proteanhq.com.

Contributing

Note: Protean framework is not associated or related to Protean eGov Technologies or Code for Gov Tech initiatives.

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the repository on GitHub, branch off main and start making your changes.
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request and bug the maintainer until it gets merged and published.

For more information, please check out the community section.

License

BSD 3-Clause License

Copyright (c) 2018-2024, Subhash Bhushan C. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Owner

  • Name: proteanhq
  • Login: proteanhq
  • Kind: organization

GitHub Events

Total
  • Create event: 99
  • Release event: 3
  • Issues event: 25
  • Watch event: 17
  • Delete event: 90
  • Issue comment event: 139
  • Push event: 214
  • Pull request review comment event: 23
  • Pull request review event: 29
  • Pull request event: 227
  • Fork event: 33
Last Year
  • Create event: 99
  • Release event: 3
  • Issues event: 25
  • Watch event: 17
  • Delete event: 90
  • Issue comment event: 139
  • Push event: 214
  • Pull request review comment event: 23
  • Pull request review event: 29
  • Pull request event: 227
  • Fork event: 33

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 849
  • Total Committers: 10
  • Avg Commits per committer: 84.9
  • Development Distribution Score (DDS): 0.22
Past Year
  • Commits: 9
  • Committers: 3
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.222
Top Committers
Name Email Commits
Subhash Bhushan s****n@g****m 662
pyup.io bot g****t@p****o 100
abhishekram a****6@g****m 58
Abhishek Ram a****m@m****m 15
Subhash Bhushan s****n@p****m 6
A D Vishnu Prasad a****d@g****m 3
Sagar a****r@g****m 2
Nadir Hamid m****d@g****m 1
Gaurav sah 7****l 1
Abhirath Mahipal a****7@g****m 1
Committer Domains (Top 20 + Academic)
prysm.com: 1 me.com: 1 pyup.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 80
  • Total pull requests: 416
  • Average time to close issues: over 1 year
  • Average time to close pull requests: 3 days
  • Total issue authors: 6
  • Total pull request authors: 21
  • Average comments per issue: 0.56
  • Average comments per pull request: 0.52
  • Merged pull requests: 321
  • Bot issues: 0
  • Bot pull requests: 179
Past Year
  • Issues: 12
  • Pull requests: 237
  • Average time to close issues: 17 days
  • Average time to close pull requests: 4 days
  • Issue authors: 3
  • Pull request authors: 15
  • Average comments per issue: 0.25
  • Average comments per pull request: 0.55
  • Merged pull requests: 156
  • Bot issues: 0
  • Bot pull requests: 155
View more stats
Top Authors
Issue Authors
  • subhashb (69)
  • advishnuprasad (6)
  • abhirathmahipal (2)
  • john-pollo-r (1)
  • abhishek-ram (1)
  • Rajat-Yd (1)
Pull Request Authors
  • dependabot[bot] (179)
  • subhashb (156)
  • pyup-bot (29)
  • Ayush3941 (7)
  • SarthakB11 (6)
  • Paroksh1 (4)
  • Elite1213 (4)
  • shashi-sah2003 (4)
  • sneha4948 (4)
  • Arpita1129 (4)
  • advishnuprasad (3)
  • Vatssss (2)
  • dhairyasquad73 (2)
  • Adigain (2)
  • loystonpais (2)
Top Labels
Issue Labels
enhancement (20) bug (7) good first issue (5) architecture (3) help wanted (3) security (1) proposal (1)
Pull Request Labels
dependencies (179) python (121) enhancement (28) bug (4) architecture (2) eventing (2) infra (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 2,596 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 4
  • Total versions: 46
  • Total maintainers: 1
pypi.org: protean

Protean Application Framework

  • Versions: 46
  • Dependent Packages: 0
  • Dependent Repositories: 4
  • Downloads: 2,596 Last month
Rankings
Dependent repos count: 7.5%
Downloads: 8.7%
Dependent packages count: 10.1%
Average: 11.5%
Forks count: 12.6%
Stargazers count: 18.5%
Maintainers (1)
subhashb
Last synced: 6 months ago

Dependencies

.github/workflows/ci.yml actions
  • actions/cache v1 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
  • elastic/elastic-github-actions/elasticsearch master composite
  • postgres 11 docker
  • redis * docker
docker-compose.yml docker
  • elasticsearch 7.12.0
  • ethangarofolo/message-db 1.2.6
  • kibana 7.12.0
  • postgres 11
  • redis 6.0.9-buster
docs/requirements.txt pypi
setup.py pypi