Skip to content

Commit

Permalink
Housekeeping
Browse files Browse the repository at this point in the history
  • Loading branch information
rnixx committed Apr 18, 2024
1 parent 95e5d04 commit aad426a
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 50 deletions.
8 changes: 4 additions & 4 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Changelog
=========
Changes
=======

2.0b2 (unreleased)
------------------
Expand Down Expand Up @@ -72,8 +72,8 @@ Changelog
[petschki]


1.0a1 (unreleased)
------------------
1.0a1
-----

- Replace unittest2 with unittest
[llisa123]
Expand Down
3 changes: 1 addition & 2 deletions LICENSE.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@

License
=======

Copyright (c) 2012-2023, BlueDynamics Alliance, Austria
Copyright (c) 2012-2024, BlueDynamics Alliance, Austria
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
43 changes: 21 additions & 22 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
==============
bda.plone.shop
==============

Expand All @@ -12,14 +11,14 @@ E-commerce solution for `Plone <http://plone.com>`_


Installation
============
------------

Depend your instance to ``bda.plone.shop`` and install it as addon in plone
control panel.


Development and testing
=======================
-----------------------

Checkout ``bda.plone.shop`` from
``git://github.com/bluedynamics/bda.plone.shop.git`` and run::
Expand All @@ -31,7 +30,7 @@ running tests.


Running tests
-------------
~~~~~~~~~~~~~

If you have run the buildout, you can run all tests like so::

Expand Down Expand Up @@ -59,7 +58,7 @@ https://docs.plone.org/external/plone.app.robotframework/docs/source/happy.html


Enable Content to be buyable
============================
----------------------------

Content which represent buyable items must implement
``bda.plone.orders.interfaces.IBuyable``.
Expand All @@ -81,8 +80,8 @@ For Plone 5 'Summary View' is overriden for folders and collections to show your
buyables with controls to add them into the cart.


Dexterity
---------
Dexterity Behaviors
~~~~~~~~~~~~~~~~~~~

The Dexterity related implementation consists of Behaviors for each interface.
These are (shortname in brackets):
Expand Down Expand Up @@ -110,7 +109,7 @@ reached.


Cart item preview images
========================
------------------------

The cart can render preview images for the cart items in case when the context
has a field named ``image``
Expand Down Expand Up @@ -140,7 +139,7 @@ Register your adapter via ZCML::


Permissions
===========
-----------

In general, custom shop deployments are likely to configure the permission and
role settings according to their use cases.
Expand All @@ -157,7 +156,7 @@ usually makes no sense to give a customer settings like a preferred editor.


bda.plone.shop.ViewBuyableInfo
------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This permission controls whether a user can view basic buyable information.
These are item availability and item price. By default, this permission is set
Expand All @@ -180,7 +179,7 @@ integration package.


bda.plone.shop.ModifyCart
-------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~

This permission controls whether a user can actually add or update this item to
shopping cart. By default, this permission is set for roles:
Expand All @@ -196,7 +195,7 @@ features like viewing own orders are bound to ``Customer`` role.


Customizing the shop
====================
--------------------

We know that every web-shop has different needs. This is why ``bda.plone.shop``
has been designed with maximum flexibility in mind.
Expand Down Expand Up @@ -239,7 +238,7 @@ respectively.


Troubleshooting
===============
---------------

If you're missing widgets in the ``@@item_discount`` form (eg. the Autocomplete
for users or groups), you might want to reinstall (or re-run the GS import
Expand All @@ -257,7 +256,7 @@ recent versions of ``yafowil`` >= 2.1 and yafowil related packages.


Create translations
===================
-------------------

::

Expand All @@ -266,10 +265,10 @@ Create translations


Backward incompatible changes
=============================
-----------------------------

1.0a1
-----
~~~~~

* ``bda.plone.shop: Buy Items`` permission has been renamed to
``bda.plone.shop: Modify Cart``. If you have custom ``rolemap.xml`` in your
Expand All @@ -278,21 +277,22 @@ Backward incompatible changes


Upgrade to Plone 5
==================
------------------

If you upgrade to Plone 5, you have to run the upgrade step
``Remove old JS and CSS resources for Plone 5`` manually to remove the old
registration of resources.


Contributors
============
------------

We'd be happy to see forks and pull-requests to improve this program.
Professional support is offered by the maintainers and some of the authors.


Maintainers
-----------
~~~~~~~~~~~

- Robert Niederreiter
- Peter Holzer
Expand All @@ -302,9 +302,9 @@ Contact: `[email protected] <mailto:[email protected]>`_


Authors
-------
~~~~~~~

- Robert Niederreiter (initial Author)
- Robert Niederreiter (Author)
- Peter Holzer
- Peter Mathis
- Harald Frießnegger
Expand All @@ -313,4 +313,3 @@ Authors
- Jure Cerjak
- Benjamin Stefaner
- Jens Klein

16 changes: 0 additions & 16 deletions TODO.rst

This file was deleted.

20 changes: 14 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
import os
from setuptools import setup
from setuptools import find_packages
from setuptools import setup
import os


def read_file(name):
with open(os.path.join(os.path.dirname(__file__), name)) as f:
return f.read()


version = '2.0b2.dev0'
shortdesc = "Shop Solution for Plone"
longdesc = open(os.path.join(os.path.dirname(__file__), 'README.rst')).read()
longdesc += open(os.path.join(os.path.dirname(__file__), 'CHANGES.rst')).read()
longdesc += open(os.path.join(os.path.dirname(__file__), 'LICENSE.rst')).read()
longdesc = '\n\n'.join([read_file(name) for name in [
'README.rst',
'CHANGES.rst',
'LICENSE.rst'
]])


setup(
Expand All @@ -23,10 +30,11 @@
"Framework :: Zope :: 5",
"License :: OSI Approved :: GNU General Public License (GPL)",
"Programming Language :: Python",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Software Development :: Libraries :: Python Modules",
],
author='BlueDynamics Alliance',
Expand Down

0 comments on commit aad426a

Please sign in to comment.