diff --git a/README.rst b/README.rst index e8b9c596..b3926d11 100644 --- a/README.rst +++ b/README.rst @@ -64,20 +64,20 @@ Main Components :alt: The Client :target: https://github.com/TDKorn/my-magento/blob/sphinx-docs/magento/clients.py -.. admonition:: The `Client `_ +.. admonition:: The `Client `_ :class: client * Handles all interactions with the API, with support for multiple store views * Accessible from all objects created by the package -.. admonition:: The `SearchQuery `_ and Subclasses +.. admonition:: The `SearchQuery `_ and Subclasses :class: search - * `execute() `_ predefined or custom search queries on any endpoint + * `execute() `_ predefined or custom search queries on any endpoint * Supports simple and advanced `searches using REST endpoints `_ -.. admonition:: The `Model `_ Subclasses +.. admonition:: The `Model `_ Subclasses :class: hint * Wrap all API responses in the package @@ -110,7 +110,7 @@ Full documentation can be found on `ReadTheDocs `_ a `Client `_ +Use the credentials of your Magento 2 admin account to initialize and `authenticate() `_ a `Client `_ .. code-block:: python diff --git a/README_PyPi.rst b/README_PyPi.rst index 0ebca5d4..ed5b2ac4 100644 --- a/README_PyPi.rst +++ b/README_PyPi.rst @@ -4,7 +4,7 @@ MyMagento --------------- -.. image:: _static/magento_orange.png +.. image:: https://my-magento.readthedocs.io/en/latest/_static/magento_orange.png :alt: Magento Logo :align: center :width: 100 @@ -59,20 +59,20 @@ Main Components :alt: The Client :target: https://github.com/TDKorn/my-magento/blob/sphinx-docs/magento/clients.py -.. admonition:: The `Client `_ +.. admonition:: The `Client `_ :class: client * Handles all interactions with the API, with support for multiple store views * Accessible from all objects created by the package -.. admonition:: The `SearchQuery `_ and Subclasses +.. admonition:: The `SearchQuery `_ and Subclasses :class: search - * `execute() `_ predefined or custom search queries on any endpoint + * `execute() `_ predefined or custom search queries on any endpoint * Supports simple and advanced `searches using REST endpoints `_ -.. admonition:: The `Model `_ Subclasses +.. admonition:: The `Model `_ Subclasses :class: hint * Wrap all API responses in the package @@ -104,7 +104,7 @@ Full documentation can be found on `ReadTheDocs `_ a `Client `_ +Use the credentials of your Magento 2 admin account to initialize and `authenticate() `_ a `Client `_ .. code-block:: python diff --git a/setup.py b/setup.py index ec34e116..13067805 100644 --- a/setup.py +++ b/setup.py @@ -1,8 +1,8 @@ import os -from setuptools import setup +from setuptools import setup, find_packages -LONG_DESCRIPTION_SRC = 'README.rst' +LONG_DESCRIPTION_SRC = 'README_PyPi.rst' def read(file): @@ -12,10 +12,10 @@ def read(file): setup( name='my-magento', - packages=['magento'], - version='2.0.0b1', + packages=find_packages(), + version='2.0.0', license='MIT', - description='Python Magento 2 REST API Client and Wrapper', + description='Python Magento 2 REST API Wrapper', long_description=read(LONG_DESCRIPTION_SRC), long_description_content_type="text/x-rst; charset=UTF-8", author='Adam Korn',