معرفی شرکت ها
awesome-sso-0.5.4
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
sso general utility for services connected to sso
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | awesome-sso-0.5.4 |
| نام | awesome-sso |
| نسخه کتابخانه | 0.5.4 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Schwannden Kuo |
| ایمیل نویسنده | schwannden@mobagel.com |
| آدرس صفحه اصلی | https://github.com/MoBagel/awesome-sso |
| آدرس اینترنتی | https://pypi.org/project/awesome-sso/ |
| مجوز | Apache-2.0 |
[](https://pypi.org/project/awesome-sso/)
[](https://github.com/MoBagel/awesome-sso)
[](https://coveralls.io/github/MoBagel/awesome-sso)
# Awesome SSO
A library designed to host common components for a cluster of microservices sharing a single sign on.
## Feature
- [x] A common exception class, supporting both status code and custom error code to map to more detailed error message
or serve as i18n key.
- [x] A common FastAPI app for interaction with service, like login ,registration and unregistration.
- [x] a connector for minio object store.
- [x] a connector for beanie, a mongo odm compatible with pydantic.
## Usage
### Installation
1. `pip install awesome-sso`
### Exceptions
Using fast API as example, we may simply throw exception with a proper status code, and an optional error code. We may
also supply arbitrary key value in args dict, to help frontend render better error message.
```python
from awesome_sso.exceptions import NotFound
from fastapi import APIRouter
router = APIRouter()
@router.get('/transactions')
def get(id: str):
try:
obj = find_by_id(id)
except Exception as e:
raise NotFound(message='transaction not found' % id, error_code='A0001', args={id: id})
...
```
And we may implement a common error handler to convert all these errors to proper response schema
```python
from awesome_sso.exceptions import HTTPException
from fastapi.requests import Request
from fastapi.responses import JSONResponse
@app.exception_handler(HTTPException)
async def http_exception_handler(request: Request, exc: HTTPException):
return JSONResponse(
status_code=exc.status_code,
content={
'detail': exc.detail,
'error_code': exc.error_code,
}
)
```
This would result in a response with status code 404, and body
```json
{
"status_code": 404,
"detail": {
"message": "transaction not found",
"id": "some_id"
},
"error_code": "A0001"
}
```
With this response, frontend can decide to simply render detail, or map it to detailed message. If error_code "A0001"
correspond to the following i18 n entry
```json
"error.A0001": {"en-US": "transaction can not be found with supplied {id}: {message}"}
```
we may format message accordingly with
```typescript
errorMessage = formatMessage({ id: `error.${error.data.error_code}` }, error.data.detail);
```
Note that error code is not supplied, is default to status code. So it is always safe to simply use error_code in
frontend to decide what to render.
### Data Store
#### Minio
refer to `tests/test_minio.py`
#### Mongo
refer to `tests/service/test_user.py`
```python
from beanie import init_beanie
from motor.motor_asyncio import AsyncIOMotorClient
from awesome_sso.service.user.schema import AwesomeUser
def init_mongo():
settings = YOUR_SETTINGS()
models = [AwesomeUser]
cli = AsyncIOMotorClient(settings.mongodb_dsn)
await init_beanie(
database=cli[settings.mongodb_db_name],
document_models=models,
)
for model in models:
await model.get_motor_collection().drop()
await model.get_motor_collection().drop_indexes()
```
### Service
#### configure service settings
```python
from awesome_sso.service.settings import Settings
settings = Settings()
settings.init_app(
symmetric_key='YOUR_SYMMETRIC_KEY', # to encode and decode service token
public_key='YOUR_PUBLIC_KEY', # to decode the token signed by sso
user_model=USER_MODEL, # user orm needs to inherit AwesomeUser from `awesome_sso.user.schema`
service_name='YOUR_SERVICE_NAME', # for service discovery, to recognize service
sso_domain='YOUR_SSO_DOMAIN', # for service registration and sync user
)
```
#### initial service and mount to your application
```python
from awesome_sso.service import Service
from fastapi import FastAPI
app = FastAPI()
service = Service()
service.init_app(YOUR_FASTAPI_APP)
app.mount('/YOUR/PATH', YOUR_FASTAPI_APP)
```
then open the api doc, you will see the apis in `awesome_sso.service.user.route`
## Development
### Installing Poetry
1. create your own environment for poetry, and simply run: `pip install poetry`
2. alternatively, you can refer to [poetry's official page](https://github.com/python-poetry/poetry)
3. to be able to use `poe` directly, `pip install poethepoet`
### Contributing
1. project setup: `poetry install`
2. create your own branch to start developing new feature.
3. before creating pr, make sure you pass `poe lint` and `./run_test.sh`.
- what happened inside `./run_test.sh` is that a minio server is setup for you temporarily, and teardown and unit
test is finished.
- notice that `poe test` would also work if you already have a minio up and running. You need the following env
variable: `MINIO_ACCESS_KEY`, `MINIO_SECRET_KEY`, `MINIO_ADDRESS` upon running `poe test`.
4. for a list of available poe command, `poe`
5. after you submit a pr, you should check if pipeline is successful.
### Releasing
1. `poetry version [new_version]`
2. `git commit -m"Bump version"`
3. `git push origin develop`
4. [create new release](https://github.com/MoBagel/awesome-sso/releases/new) on github.
5. Create release off develop branch, auto generate notes, and review release note.
6. Publish release
نیازمندی
| مقدار | نام |
|---|---|
| >=1.8.0,<2.0.0 | beanie |
| >=0.70.0,<0.71.0 | fastapi |
| >=3.2.0,<4.0.0 | bcrypt |
| >=36.0.0,<37.0.0 | cryptography |
| >=1.8.2,<2.0.0 | pydantic[email] |
| >=3.8.1,<4.0.0 | APScheduler |
| >=5.8.0,<6.0.0 | psutil |
| >=0.16.0,<0.17.0 | uvicorn |
| >=1.3.5,<2.0.0 | pandas |
| >=2.3.0,<3.0.0 | PyJWT |
| >=1.1.0,<2.0.0 | awesome-exception |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.8,<4.0 | Python |
نحوه نصب
نصب پکیج whl awesome-sso-0.5.4:
pip install awesome-sso-0.5.4.whl
نصب پکیج tar.gz awesome-sso-0.5.4:
pip install awesome-sso-0.5.4.tar.gz