Skip to content

Commit 08ba802

Browse files
committed
chore: add badge for pypi and load readme as long description
1 parent 3cceb25 commit 08ba802

File tree

3 files changed

+32
-7
lines changed

3 files changed

+32
-7
lines changed

.gitignore

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,25 @@ target/
6767

6868
#Ipython Notebook
6969
.ipynb_checkpoints
70+
71+
72+
# IDEs
73+
.idea
74+
.vscode
75+
.sublime-workspace
76+
.sublime-project
77+
.idea/
78+
.vscode/
79+
80+
# Possible credential files
81+
.env
82+
credentials.json
83+
84+
# git conflict leftover files
85+
*.orig
86+
87+
# Mac
88+
.DS_Store
89+
90+
VERSION.txt
91+
git_push.sh

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Python SDK for OpenFGA
22

3+
[![pypi](https://img.shields.io/pypi/v/openfga_sdk.svg?style=flat)](https://pypi.org/project/openfga_sdk)
34
[![Release](https://img.shields.io/github/v/release/openfga/python-sdk?sort=semver&color=green)](https://github.com/openfga/python-sdk/releases)
45
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
5-
[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B4989%2Fgithub.com%2Fopenfga%2Fpython-sdk.svg?type=shield)](https://app.fossa.com/api/projects/custom%2B4989%2Fgithub.com%2Fopenfga%2Fpython-sdk.svg?type=shield)
6+
[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B4989%2Fgithub.com%2Fopenfga%2Fpython-sdk.svg?type=shield)](https://app.fossa.com/reports/824fbc44-7513-4496-84a4-f7ffb3fa23f7)
67
[![Discord Server](https://img.shields.io/discord/759188666072825867?color=7289da&logo=discord "Discord Server")](https://discord.com/channels/759188666072825867/930524706854031421)
78
[![Twitter](https://img.shields.io/twitter/follow/openfga?color=%23179CF0&logo=twitter&style=flat-square "@openfga on Twitter")](https://twitter.com/openfga)
89

setup.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@
2626
REQUIRES = ["urllib3 >= 1.26.11", "six >= 1.10", "python-dateutil >= 2.8.2"]
2727
REQUIRES.append("aiohttp >= 3.8.1")
2828

29+
from setuptools import setup
30+
31+
# read the contents of your README file
32+
from pathlib import Path
33+
this_directory = Path(__file__).parent
34+
long_description = (this_directory / "README.md").read_text()
35+
2936
setup(
3037
name=NAME,
3138
version=VERSION,
@@ -49,10 +56,5 @@
4956
include_package_data=True,
5057
license="Apache-2.0",
5158
long_description_content_type='text/markdown',
52-
long_description="""\
53-
[OpenFGA](https://openfga.dev) is an open source Fine-Grained Authorization solution inspired by [Google's Zanzibar paper](https://research.google/pubs/pub48190/). It was created by the FGA team at [Auth0](https://auth0.com) based on [Auth0 Fine-Grained Authorization (FGA)](https://fga.dev), available under [a permissive license (Apache-2)](https://github.com/openfga/rfcs/blob/main/LICENSE) and welcomes community contributions.
54-
55-
OpenFGA is designed to make it easy for application builders to model their permission layer, and to add and integrate fine-grained authorization into their applications. OpenFGA’s design is optimized for reliability and low latency at a high scale.
56-
57-
"""
59+
long_description=long_description
5860
)

0 commit comments

Comments
 (0)