From 1ecc02d14693e1a0589af3ba800908b4d9aed730 Mon Sep 17 00:00:00 2001 From: Dulmandakh Date: Mon, 24 Jun 2024 12:49:44 +0800 Subject: [PATCH] remove README.rst --- README.rst | 171 ----------------------------------------------------- setup.py | 3 +- 2 files changed, 2 insertions(+), 172 deletions(-) delete mode 100644 README.rst diff --git a/README.rst b/README.rst deleted file mode 100644 index 6b26404f..00000000 --- a/README.rst +++ /dev/null @@ -1,171 +0,0 @@ -|Graphene Logo| `Graphene `__ |Build Status| |PyPI version| |Coverage Status| -========================================================================================================= - -`💬 Join the community on -Slack `__ - -**We are looking for contributors**! Please check the -`ROADMAP `__ -to see how you can help ❤️ - -Introduction ------------- - -`Graphene `__ is an opinionated Python -library for building GraphQL schemas/types fast and easily. - -- **Easy to use:** Graphene helps you use GraphQL in Python without - effort. -- **Relay:** Graphene has builtin support for Relay. -- **Data agnostic:** Graphene supports any kind of data source: SQL - (Django, SQLAlchemy), NoSQL, custom Python objects, etc. We believe - that by providing a complete API you could plug Graphene anywhere - your data lives and make your data available through GraphQL. - -Integrations ------------- - -Graphene has multiple integrations with different frameworks: - -+-------------------+-------------------------------------------------+ -| integration | Package | -+===================+=================================================+ -| Django | `graphene-django `__ | -+-------------------+-------------------------------------------------+ -| SQLAlchemy | `graphene-sqlalchemy `__ | -+-------------------+-------------------------------------------------+ - -Also, Graphene is fully compatible with the GraphQL spec, working -seamlessly with all GraphQL clients, such as -`Relay `__, -`Apollo `__ and -`gql `__. - -Installation ------------- - -To install `graphene`, just run this command in your shell - -.. code:: bash - - pip install "graphene>=3.0" - -Examples --------- - -Here is one example for you to get started: - -.. code:: python - - import graphene - - class Query(graphene.ObjectType): - hello = graphene.String(description='A typical hello world') - - def resolve_hello(self, info): - return 'World' - - schema = graphene.Schema(query=Query) - -Then Querying ``graphene.Schema`` is as simple as: - -.. code:: python - - query = ''' - query SayHello { - hello - } - ''' - result = schema.execute(query) - -If you want to learn even more, you can also check the following -`examples `__: - -- **Basic Schema**: `Starwars example `__ -- **Relay Schema**: `Starwars Relay - example `__ - -Documentation -------------- - -Documentation and links to additional resources are available at -https://docs.graphene-python.org/en/latest/ - -Contributing ------------- - -After cloning this repo, create a -`virtualenv `__ and ensure -dependencies are installed by running: - -.. code:: sh - - virtualenv venv - source venv/bin/activate - pip install -e ".[test]" - -Well-written tests and maintaining good test coverage is important to -this project. While developing, run new and existing tests with: - -.. code:: sh - - py.test graphene/relay/tests/test_node.py # Single file - py.test graphene/relay # All tests in directory - -Add the ``-s`` flag if you have introduced breakpoints into the code for -debugging. Add the ``-v`` (“verbose”) flag to get more detailed test -output. For even more detailed output, use ``-vv``. Check out the -`pytest documentation `__ for more -options and test running controls. - -You can also run the benchmarks with: - -.. code:: sh - - py.test graphene --benchmark-only - -Graphene supports several versions of Python. To make sure that changes -do not break compatibility with any of those versions, we use ``tox`` to -create virtualenvs for each Python version and run tests with that -version. To run against all Python versions defined in the ``tox.ini`` -config file, just run: - -.. code:: sh - - tox - -If you wish to run against a specific version defined in the ``tox.ini`` -file: - -.. code:: sh - - tox -e py10 - -Tox can only use whatever versions of Python are installed on your -system. When you create a pull request, Travis will also be running the -same tests and report the results, so there is no need for potential -contributors to try to install every single version of Python on their -own system ahead of time. We appreciate opening issues and pull requests -to make graphene even more stable & useful! - -Building Documentation -~~~~~~~~~~~~~~~~~~~~~~ - -The documentation is generated using the excellent -`Sphinx `__ and a custom theme. - -An HTML version of the documentation is produced by running: - -.. code:: sh - - make docs - -.. |Graphene Logo| image:: http://graphene-python.org/favicon.png -.. |Build Status| image:: https://travis-ci.org/graphql-python/graphene.svg?branch=master - :target: https://travis-ci.org/graphql-python/graphene -.. |PyPI version| image:: https://badge.fury.io/py/graphene.svg - :target: https://badge.fury.io/py/graphene -.. |Coverage Status| image:: https://coveralls.io/repos/graphql-python/graphene/badge.svg?branch=master&service=github - :target: https://coveralls.io/github/graphql-python/graphene?branch=master diff --git a/setup.py b/setup.py index 33f61114..cf566531 100644 --- a/setup.py +++ b/setup.py @@ -61,8 +61,9 @@ setup( version=version, description="GraphQL Framework for Python", long_description=codecs.open( - "README.rst", "r", encoding="ascii", errors="replace" + "README.md", "r", encoding="ascii", errors="replace" ).read(), + long_description_content_type="text/markdown", url="https://github.com/graphql-python/graphene", author="Syrus Akbary", author_email="me@syrusakbary.com",