cullinan


Namecullinan JSON
Version 0.56 PyPI version JSON
download
home_pagehttps://github.com/plumeink/Cullinan
SummaryCullinan is written based on tornado and Sqlalchemy to help the project quickly build web application
upload_time2024-11-09 21:12:54
maintainerNone
docs_urlNone
authorplumeink
requires_python>=3
licensehttp://www.apache.org/licenses/LICENSE-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![Python version](https://img.shields.io/badge/python-3.6%20|%203.7%20|%203.8%20|%203.9%20|%203.10|%203.11|%203.12|%203.13-blue)
![PyPI version](https://img.shields.io/pypi/v/cullinan.svg?style=flat&logo=pypi&color=green)
![PyPI downloads](https://img.shields.io/pypi/dm/cullinan.svg?style=flat&logo=pypi&color=blue)
![GitHub stars](https://img.shields.io/github/stars/plumeink/cullinan.svg?style=flat&logo=github&color=white)
![License](https://img.shields.io/github/license/plumeink/cullinan.svg?style=flat&color=white)
```                                              
   _____      _ _ _                      
  / ____|    | | (_)                     
 | |    _   _| | |_ _ __   __ _ _ __     
 | |   | | | | | | | '_ \ / _` | '_ \    
 | |___| |_| | | | | | | | (_| | | | |   
 \_____\__, _|_|_|_|_| |_|\__,_|_| |_|  
```
# Cullinan

Cullinan is written based on tornado and Sqlalchemy to help the project quickly build web application

## How to use
    
#### install
     
    pip install cullinan
    
---
#### demo

File controller:
```python
from cullinan.controller import controller, get_api

@controller()
class TestController:
    
    @get_api(uri='/get', query_params=['id', 'name'])
    def get(self, query_params):
        return self.service['TestService'].test(query_params['id'], query_params['name'])
```

File service:
```python
from cullinan.service import Service, service

@service
class TestService(Service):
    def test(self, id, name):
        self.response.set_body({ 'id': id, 'name': name })
        return self.response
```

File application:
```python
from cullinan import application

def main():
    application.run()

if __name__ == '__main__':
    main()
```
Now, A web application demo is completed!

---
#### File structure:
```
project
   |----application.py                               # Web Application main entrance
   |----controller                                   # Controller package
   |  |----TestController.py                            
   |----service                                      # Service package
   |  |----TestService.py                               
```

## Wiki

wiki and other related references: https://github.com/plumeink/Cullinan/wiki

## Maintainer

[<img src="https://avatars.githubusercontent.com/u/104434649?v=4" width = "40" height = "40"/>](https://github.com/plumeink)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/plumeink/Cullinan",
    "name": "cullinan",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": null,
    "keywords": null,
    "author": "plumeink",
    "author_email": "official@plumeink.com",
    "download_url": "https://files.pythonhosted.org/packages/3c/97/9fd8708868b52bb16e059678b08cbbeb8ec4595cd3714d22fcfa205727ab/cullinan-0.56.tar.gz",
    "platform": null,
    "description": "![Python version](https://img.shields.io/badge/python-3.6%20|%203.7%20|%203.8%20|%203.9%20|%203.10|%203.11|%203.12|%203.13-blue)\n![PyPI version](https://img.shields.io/pypi/v/cullinan.svg?style=flat&logo=pypi&color=green)\n![PyPI downloads](https://img.shields.io/pypi/dm/cullinan.svg?style=flat&logo=pypi&color=blue)\n![GitHub stars](https://img.shields.io/github/stars/plumeink/cullinan.svg?style=flat&logo=github&color=white)\n![License](https://img.shields.io/github/license/plumeink/cullinan.svg?style=flat&color=white)\n```                                              \n   _____      _ _ _                      \n  / ____|    | | (_)                     \n | |    _   _| | |_ _ __   __ _ _ __     \n | |   | | | | | | | '_ \\ / _` | '_ \\    \n | |___| |_| | | | | | | | (_| | | | |   \n \\_____\\__, _|_|_|_|_| |_|\\__,_|_| |_|  \n```\n# Cullinan\n\nCullinan is written based on tornado and Sqlalchemy to help the project quickly build web application\n\n## How to use\n    \n#### install\n     \n    pip install cullinan\n    \n---\n#### demo\n\nFile controller:\n```python\nfrom cullinan.controller import controller, get_api\n\n@controller()\nclass TestController:\n    \n    @get_api(uri='/get', query_params=['id', 'name'])\n    def get(self, query_params):\n        return self.service['TestService'].test(query_params['id'], query_params['name'])\n```\n\nFile service:\n```python\nfrom cullinan.service import Service, service\n\n@service\nclass TestService(Service):\n    def test(self, id, name):\n        self.response.set_body({ 'id': id, 'name': name })\n        return self.response\n```\n\nFile application:\n```python\nfrom cullinan import application\n\ndef main():\n    application.run()\n\nif __name__ == '__main__':\n    main()\n```\nNow, A web application demo is completed!\n\n---\n#### File structure:\n```\nproject\n   |----application.py                               # Web Application main entrance\n   |----controller                                   # Controller package\n   |  |----TestController.py                            \n   |----service                                      # Service package\n   |  |----TestService.py                               \n```\n\n## Wiki\n\nwiki and other related references: https://github.com/plumeink/Cullinan/wiki\n\n## Maintainer\n\n[<img src=\"https://avatars.githubusercontent.com/u/104434649?v=4\" width = \"40\" height = \"40\"/>](https://github.com/plumeink)\n",
    "bugtrack_url": null,
    "license": "http://www.apache.org/licenses/LICENSE-2.0",
    "summary": "Cullinan is written based on tornado and Sqlalchemy to help the project quickly build web application",
    "version": "0.56",
    "project_urls": {
        "Homepage": "https://github.com/plumeink/Cullinan",
        "Source": "https://github.com/plumeink/Cullinan",
        "Wiki": "https://github.com/plumeink/Cullinan/wiki"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b4dff4fa7e8b3400a2492909841db7f43fb940fe99277ceafe6ddba69c11773c",
                "md5": "59ac1aa45d62d9efe1bbe7a855df4d7b",
                "sha256": "4b343bf36592de4e64398ba9206fc8865d7da63c70f125bf41f90de2d71edeec"
            },
            "downloads": -1,
            "filename": "cullinan-0.56-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "59ac1aa45d62d9efe1bbe7a855df4d7b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3",
            "size": 14638,
            "upload_time": "2024-11-09T21:12:52",
            "upload_time_iso_8601": "2024-11-09T21:12:52.560081Z",
            "url": "https://files.pythonhosted.org/packages/b4/df/f4fa7e8b3400a2492909841db7f43fb940fe99277ceafe6ddba69c11773c/cullinan-0.56-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3c979fd8708868b52bb16e059678b08cbbeb8ec4595cd3714d22fcfa205727ab",
                "md5": "6397680c3a86fdf0ce81dc39d4a0e3ca",
                "sha256": "dc9cd6ec85c5934353e4afeb8d8ac40df0a51f88ef559231f5b60b1ea02a2383"
            },
            "downloads": -1,
            "filename": "cullinan-0.56.tar.gz",
            "has_sig": false,
            "md5_digest": "6397680c3a86fdf0ce81dc39d4a0e3ca",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 13707,
            "upload_time": "2024-11-09T21:12:54",
            "upload_time_iso_8601": "2024-11-09T21:12:54.085808Z",
            "url": "https://files.pythonhosted.org/packages/3c/97/9fd8708868b52bb16e059678b08cbbeb8ec4595cd3714d22fcfa205727ab/cullinan-0.56.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-09 21:12:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "plumeink",
    "github_project": "Cullinan",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cullinan"
}
        
Elapsed time: 0.36219s