diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-06-20 04:26:21 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-06-20 04:26:21 +0000 |
| commit | 004b36b45e22bede521f2d158f68f0f6a448d26d (patch) | |
| tree | dc70b68a425821682cd6fc2340ed85eecb31ce08 | |
| parent | 87a557cca85de68679fb2b6c7c4dc5e99508d4b1 (diff) | |
automatic import of python-mezzanine-cartridge-apiopeneuler20.03
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-mezzanine-cartridge-api.spec | 546 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 548 insertions, 0 deletions
@@ -0,0 +1 @@ +/mezzanine_cartridge_api-1.5.17.tar.gz diff --git a/python-mezzanine-cartridge-api.spec b/python-mezzanine-cartridge-api.spec new file mode 100644 index 0000000..b9d724a --- /dev/null +++ b/python-mezzanine-cartridge-api.spec @@ -0,0 +1,546 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mezzanine-cartridge-api +Version: 1.5.17 +Release: 1 +Summary: A REST Web API for Mezzanine CMS with the Cartridge e-commerce extension +License: MIT License +URL: https://github.com/jackvz/mezzanine-cartridge-api +Source0: https://mirrors.aliyun.com/pypi/web/packages/7a/d0/a63dbb9e2dbaedae2349e5e0bd3127837c5151d2e588a9249e6a376c0689/mezzanine_cartridge_api-1.5.17.tar.gz +BuildArch: noarch + + +%description +# Mezzanine API + +[](https://pypi.org/project/mezzanine-cartridge-api/) +[](https://travis-ci.com/jackvz/mezzanine-cartridge-api) +[](https://github.com/jackvz/mezzanine-cartridge-api/blob/master/license) +[](https://codecov.io/gh/jackvz/mezzanine-cartridge-api/branch/production) + +A REST Web API for the [Mezzanine content management system](http://mezzanine.jupo.org/) with the [Cartridge](http://cartridge.jupo.org/index.html) e-commerce extension. + +Oh, and this will work even if you're just running a blog or any other Mezzanine website without the Cartridge package. + +[](https://www.buymeacoffee.com/sTZBGpQ) + +## Features + +Web API methods for Mezzanine objects, including sites, users, groups, pages, blog posts and settings, and Cartridge objects, including products, categories, carts and orders. + +[Swagger-UI](https://swagger.io/tools/swagger-ui/) as development tool and documentation. + +Comes with [API key authentication/authorisation](https://pypi.org/project/djangorestframework-api-key/) configured, but can also be configured to work with Password-based and/or Authorisation code OAuth2 authentication/authorisation. + +Additional features: +- User create and activate methods that include password hashing and sending a verification email +- User update and partial update methods that include password hashing +- Methods for checking a user password and a user token +- Password reset methods that include sending a verification email +- Methods for e-commerce customisation: Handlers for billing/shipping, tax, payment and order placement, to execute any customisation work done in the Mezzanine site installation. + +## Screenshots + +API docs + + + +API keys + + + +## Installation + +Install [Python](https://www.python.org/) + +## New installation + +Install Mezzanine and Cartridge: +```bash +pip install mezzanine +pip install cartridge +``` + +Create a new Mezzanine project with Cartridge, and set up a clean development database by running: +```bash +mezzanine-project -a cartridge [project-name] +cd [project_name] +python manage.py createdb --noinput --nodata +``` + +You may need to set ALLOWED_HOSTS, DATABASES and SHOP_CURRENCY_LOCALE in your project's settings.py file before creating the database. + + ALLOWED_HOSTS = ['*'] + + DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': 'db.dev', + } + } + + SHOP_CURRENCY_LOCALE = 'en_GB.UTF-8' + +Start a Python [virtual environment](https://virtualenv.pypa.io/en/latest/), install the requirements and run the development server: +```bash +virtualenv env +source env/bin/activate +pip install -r requirements.txt +python manage.py runserver +``` + +Then see the following section on adding to an existing installation. + +## Adding to an existing installation + +With Mezzanine and Cartridge installed, add the package to your project's requirements.txt file: + + mezzanine-cartridge-api + +Add the following to installed apps and middleware in your project's settings.py file: + + INSTALLED_APPS = ( + ... + 'corsheaders', + 'rest_framework', + 'rest_framework_api_key', + 'drf_yasg', + 'mezzanine_cartridge_api', + ... + ) + + # Use `MIDDLEWARE_CLASSES` prior to Django 1.10 + MIDDLEWARE = [ + ... + 'corsheaders.middleware.CorsMiddleware', + ... + ] + +For OAuth2 authentication/authorisation, also add the following to installed apps in your project's settings.py file: + + INSTALLED_APPS = ( + ... + 'oauth2_provider', + 'rest_framework.authtoken', + ... + ) + +Add the following to your project's urls.py file: + + urlpatterns = [ + ... + url(r'^api/', include('mezzanine_cartridge_api.urls')), + ... + ] + +Start the Python virtual environment, install the requirements and run the development server: +```bash +virtualenv env +source env/bin/activate +pip install -r requirements.txt +python manage.py runserver +``` + +## Configuration + +The following configuration settings are available: + +CORS_ORIGIN_ALLOW_ALL + +And other [django-cors-middleware](https://pypi.org/project/django-cors-middleware/) settings. + +REST_FRAMEWORK + +See the [Django REST framework settings](https://www.django-rest-framework.org/api-guide/settings/). + +SWAGGER_SETTINGS + +See the [drf-yasg Swagger settings](https://drf-yasg.readthedocs.io/en/stable/settings.html#swagger-settings). + +SWAGGER_SCHEME_HTTPS + +True or False: Defaults to False. True for when your API is available over HTTPS. + +## Client libraries + +[Dart](https://github.com/jackvz/mezzanine-dart-client) + +## Notes + +If you are using the included Swagger UI to test your API and get a message "CSRF Failed: CSRF token missing or incorrect", be sure to log out of the Mezzanine site. + +If you are using the included Swagger UI to test your API and get a message "TypeError: Failed to fetch", and you are running a secure site (over HTTPS), be sure to select the HTTPS scheme from the Shemes dropdown. This dropdown keeps reverting to HTTP in the Swagger UI, so you may have to select it again after making API call changes and/or selecting API methods. + +%package -n python3-mezzanine-cartridge-api +Summary: A REST Web API for Mezzanine CMS with the Cartridge e-commerce extension +Provides: python-mezzanine-cartridge-api +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mezzanine-cartridge-api +# Mezzanine API + +[](https://pypi.org/project/mezzanine-cartridge-api/) +[](https://travis-ci.com/jackvz/mezzanine-cartridge-api) +[](https://github.com/jackvz/mezzanine-cartridge-api/blob/master/license) +[](https://codecov.io/gh/jackvz/mezzanine-cartridge-api/branch/production) + +A REST Web API for the [Mezzanine content management system](http://mezzanine.jupo.org/) with the [Cartridge](http://cartridge.jupo.org/index.html) e-commerce extension. + +Oh, and this will work even if you're just running a blog or any other Mezzanine website without the Cartridge package. + +[](https://www.buymeacoffee.com/sTZBGpQ) + +## Features + +Web API methods for Mezzanine objects, including sites, users, groups, pages, blog posts and settings, and Cartridge objects, including products, categories, carts and orders. + +[Swagger-UI](https://swagger.io/tools/swagger-ui/) as development tool and documentation. + +Comes with [API key authentication/authorisation](https://pypi.org/project/djangorestframework-api-key/) configured, but can also be configured to work with Password-based and/or Authorisation code OAuth2 authentication/authorisation. + +Additional features: +- User create and activate methods that include password hashing and sending a verification email +- User update and partial update methods that include password hashing +- Methods for checking a user password and a user token +- Password reset methods that include sending a verification email +- Methods for e-commerce customisation: Handlers for billing/shipping, tax, payment and order placement, to execute any customisation work done in the Mezzanine site installation. + +## Screenshots + +API docs + + + +API keys + + + +## Installation + +Install [Python](https://www.python.org/) + +## New installation + +Install Mezzanine and Cartridge: +```bash +pip install mezzanine +pip install cartridge +``` + +Create a new Mezzanine project with Cartridge, and set up a clean development database by running: +```bash +mezzanine-project -a cartridge [project-name] +cd [project_name] +python manage.py createdb --noinput --nodata +``` + +You may need to set ALLOWED_HOSTS, DATABASES and SHOP_CURRENCY_LOCALE in your project's settings.py file before creating the database. + + ALLOWED_HOSTS = ['*'] + + DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': 'db.dev', + } + } + + SHOP_CURRENCY_LOCALE = 'en_GB.UTF-8' + +Start a Python [virtual environment](https://virtualenv.pypa.io/en/latest/), install the requirements and run the development server: +```bash +virtualenv env +source env/bin/activate +pip install -r requirements.txt +python manage.py runserver +``` + +Then see the following section on adding to an existing installation. + +## Adding to an existing installation + +With Mezzanine and Cartridge installed, add the package to your project's requirements.txt file: + + mezzanine-cartridge-api + +Add the following to installed apps and middleware in your project's settings.py file: + + INSTALLED_APPS = ( + ... + 'corsheaders', + 'rest_framework', + 'rest_framework_api_key', + 'drf_yasg', + 'mezzanine_cartridge_api', + ... + ) + + # Use `MIDDLEWARE_CLASSES` prior to Django 1.10 + MIDDLEWARE = [ + ... + 'corsheaders.middleware.CorsMiddleware', + ... + ] + +For OAuth2 authentication/authorisation, also add the following to installed apps in your project's settings.py file: + + INSTALLED_APPS = ( + ... + 'oauth2_provider', + 'rest_framework.authtoken', + ... + ) + +Add the following to your project's urls.py file: + + urlpatterns = [ + ... + url(r'^api/', include('mezzanine_cartridge_api.urls')), + ... + ] + +Start the Python virtual environment, install the requirements and run the development server: +```bash +virtualenv env +source env/bin/activate +pip install -r requirements.txt +python manage.py runserver +``` + +## Configuration + +The following configuration settings are available: + +CORS_ORIGIN_ALLOW_ALL + +And other [django-cors-middleware](https://pypi.org/project/django-cors-middleware/) settings. + +REST_FRAMEWORK + +See the [Django REST framework settings](https://www.django-rest-framework.org/api-guide/settings/). + +SWAGGER_SETTINGS + +See the [drf-yasg Swagger settings](https://drf-yasg.readthedocs.io/en/stable/settings.html#swagger-settings). + +SWAGGER_SCHEME_HTTPS + +True or False: Defaults to False. True for when your API is available over HTTPS. + +## Client libraries + +[Dart](https://github.com/jackvz/mezzanine-dart-client) + +## Notes + +If you are using the included Swagger UI to test your API and get a message "CSRF Failed: CSRF token missing or incorrect", be sure to log out of the Mezzanine site. + +If you are using the included Swagger UI to test your API and get a message "TypeError: Failed to fetch", and you are running a secure site (over HTTPS), be sure to select the HTTPS scheme from the Shemes dropdown. This dropdown keeps reverting to HTTP in the Swagger UI, so you may have to select it again after making API call changes and/or selecting API methods. + +%package help +Summary: Development documents and examples for mezzanine-cartridge-api +Provides: python3-mezzanine-cartridge-api-doc +%description help +# Mezzanine API + +[](https://pypi.org/project/mezzanine-cartridge-api/) +[](https://travis-ci.com/jackvz/mezzanine-cartridge-api) +[](https://github.com/jackvz/mezzanine-cartridge-api/blob/master/license) +[](https://codecov.io/gh/jackvz/mezzanine-cartridge-api/branch/production) + +A REST Web API for the [Mezzanine content management system](http://mezzanine.jupo.org/) with the [Cartridge](http://cartridge.jupo.org/index.html) e-commerce extension. + +Oh, and this will work even if you're just running a blog or any other Mezzanine website without the Cartridge package. + +[](https://www.buymeacoffee.com/sTZBGpQ) + +## Features + +Web API methods for Mezzanine objects, including sites, users, groups, pages, blog posts and settings, and Cartridge objects, including products, categories, carts and orders. + +[Swagger-UI](https://swagger.io/tools/swagger-ui/) as development tool and documentation. + +Comes with [API key authentication/authorisation](https://pypi.org/project/djangorestframework-api-key/) configured, but can also be configured to work with Password-based and/or Authorisation code OAuth2 authentication/authorisation. + +Additional features: +- User create and activate methods that include password hashing and sending a verification email +- User update and partial update methods that include password hashing +- Methods for checking a user password and a user token +- Password reset methods that include sending a verification email +- Methods for e-commerce customisation: Handlers for billing/shipping, tax, payment and order placement, to execute any customisation work done in the Mezzanine site installation. + +## Screenshots + +API docs + + + +API keys + + + +## Installation + +Install [Python](https://www.python.org/) + +## New installation + +Install Mezzanine and Cartridge: +```bash +pip install mezzanine +pip install cartridge +``` + +Create a new Mezzanine project with Cartridge, and set up a clean development database by running: +```bash +mezzanine-project -a cartridge [project-name] +cd [project_name] +python manage.py createdb --noinput --nodata +``` + +You may need to set ALLOWED_HOSTS, DATABASES and SHOP_CURRENCY_LOCALE in your project's settings.py file before creating the database. + + ALLOWED_HOSTS = ['*'] + + DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': 'db.dev', + } + } + + SHOP_CURRENCY_LOCALE = 'en_GB.UTF-8' + +Start a Python [virtual environment](https://virtualenv.pypa.io/en/latest/), install the requirements and run the development server: +```bash +virtualenv env +source env/bin/activate +pip install -r requirements.txt +python manage.py runserver +``` + +Then see the following section on adding to an existing installation. + +## Adding to an existing installation + +With Mezzanine and Cartridge installed, add the package to your project's requirements.txt file: + + mezzanine-cartridge-api + +Add the following to installed apps and middleware in your project's settings.py file: + + INSTALLED_APPS = ( + ... + 'corsheaders', + 'rest_framework', + 'rest_framework_api_key', + 'drf_yasg', + 'mezzanine_cartridge_api', + ... + ) + + # Use `MIDDLEWARE_CLASSES` prior to Django 1.10 + MIDDLEWARE = [ + ... + 'corsheaders.middleware.CorsMiddleware', + ... + ] + +For OAuth2 authentication/authorisation, also add the following to installed apps in your project's settings.py file: + + INSTALLED_APPS = ( + ... + 'oauth2_provider', + 'rest_framework.authtoken', + ... + ) + +Add the following to your project's urls.py file: + + urlpatterns = [ + ... + url(r'^api/', include('mezzanine_cartridge_api.urls')), + ... + ] + +Start the Python virtual environment, install the requirements and run the development server: +```bash +virtualenv env +source env/bin/activate +pip install -r requirements.txt +python manage.py runserver +``` + +## Configuration + +The following configuration settings are available: + +CORS_ORIGIN_ALLOW_ALL + +And other [django-cors-middleware](https://pypi.org/project/django-cors-middleware/) settings. + +REST_FRAMEWORK + +See the [Django REST framework settings](https://www.django-rest-framework.org/api-guide/settings/). + +SWAGGER_SETTINGS + +See the [drf-yasg Swagger settings](https://drf-yasg.readthedocs.io/en/stable/settings.html#swagger-settings). + +SWAGGER_SCHEME_HTTPS + +True or False: Defaults to False. True for when your API is available over HTTPS. + +## Client libraries + +[Dart](https://github.com/jackvz/mezzanine-dart-client) + +## Notes + +If you are using the included Swagger UI to test your API and get a message "CSRF Failed: CSRF token missing or incorrect", be sure to log out of the Mezzanine site. + +If you are using the included Swagger UI to test your API and get a message "TypeError: Failed to fetch", and you are running a secure site (over HTTPS), be sure to select the HTTPS scheme from the Shemes dropdown. This dropdown keeps reverting to HTTP in the Swagger UI, so you may have to select it again after making API call changes and/or selecting API methods. + +%prep +%autosetup -n mezzanine_cartridge_api-1.5.17 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mezzanine-cartridge-api -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 1.5.17-1 +- Package Spec generated @@ -0,0 +1 @@ +f22fd86429075e5dc4fcf391df4e6de1 mezzanine_cartridge_api-1.5.17.tar.gz |