Skip to content

Commit 982ccd4

Browse files
committed
Minor fixes in the documentation and links
1 parent 2cf6513 commit 982ccd4

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

docs/migrate.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ Check which Webware plug-ins you were using
1212

1313
First you should check whether the plug-ins your application is using are still available as built-ins plugin of Webware for Python 3 (`w4py3 <https://github.com/WebwareForPython/w4py3>`_) or as externally provided plug-ins. PSP is still provided as a built-in plug-in. MiddleKit is now provided as an external plug-in on GitHub (`w4py3-middlekit <https://github.com/WebwareForPython/w4py3-middlekit>`_). The "COMKit", "CGIWrapper" and "KidKit" built-in plug-ins have been discontinued. Other external plug-ins that have been developed for Webware for Python 2 must first be ported to Webware for Python 3 before you can use them. See the section on :ref:`plug-ins` for details on how to write plug-ins for Webware for Python 3.
1414

15-
.. _MiddleKit: https://github.com/WebwareForPython/w4py3-middlekit
16-
1715
Migrate your application to Python 3
1816
------------------------------------
1917

docs/overview.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Design Points and Changes
2929
* Built-in plug-ins for **Task scheduling** and **User management**.
3030
* Excellent **documentation** and numerous **examples**.
3131

32-
Another key goal of the original project was to provide a "Pythonic" API, instead of simply copying Java APIs. However, the project was created when Python 2 was still in its infancy, lacking many modern features and conventions such as PEP-8 were not yet available. Therefore, the Webware for Python API is a bit different from what is considered "Pythonic" nowadays. Particularly, it uses getters and setters instead of properties (but without the "get" prefix for getters), and camelCase method names instead of snake_case. In order to facilitate migration of existing projects, Webware for Python 3 kept this old API, even though it is not in line with PEP-8 and could be simplified by using properties. Modernizing the API will be a goal for a possible third edition of Webware for Python, as well as using the Python logging facility which did not yet exist when Webware for Python was created and is still done via printing to the standard output.
32+
Another key goal of the original project was to provide a "Pythonic" API, instead of simply copying Java APIs. However, the project was created when Python 2 was still in its infancy, lacking many modern features and conventions such as PEP-8. Therefore, the Webware for Python API is a bit different from what is considered "Pythonic" nowadays. Particularly, it uses getters and setters instead of properties (but without the "get" prefix for getters), and camelCase method names instead of snake_case. In order to facilitate migration of existing projects, Webware for Python 3 kept this old API, even though it is not in line with PEP-8 and could be simplified by using properties. Modernizing the API will be a goal for a possible third edition of Webware for Python, as well as using the Python logging facility which did not yet exist when Webware for Python was created and is still done via printing to the standard output.
3333

3434
The plug-in architecture has also been kept in Webware for Python 3, but now implemented in a more modern way using entry points for discovering plug-ins. Old plug-ins are not compatible, but can be adapted quite easily. The old Webware for Python installer has been replaced by a standard setup.py based installation.
3535

@@ -39,7 +39,7 @@ The second incisive change in Webware for Python 3 is the removal of the "Middle
3939

4040
To facilitate web development with Webware for Python 3, a ``webware`` console script has been added that can be used to create working directories for new application and start the development server. This script replaces the old ``MakeAppWorkDir`` and ``AppServer`` scripts. When creating a new working directory, a WSGI script will also be created that can be used to attach the application to a web server.
4141

42-
The documentation contexts of the various plug-ins have been replaced by a common Sphinx based documentation provided in the top level ``docs`` directory. The tests are still contained in ``Tests`` subdirectories at the top and plug-in levels, but the test suite has been expanded and is using the unittest framework consistently. The twill tests have also been replaced by unit tests based using WebTest_. They make sure that all servlets in the examples and testing contexts work as expected. Since Webware for Python 3 uses WSGI, WebTest can now also be used to test applications built with Webware for Python 3.
42+
The documentation contexts of the various plug-ins have been replaced by a common Sphinx based documentation provided in the top-level ``docs`` directory. The tests are still contained in ``Tests`` subdirectories at the top and plug-in levels, but the test suite has been expanded and is using the unittest framework consistently. The twill_ tests have also been replaced by unit tests based using WebTest_. They make sure that all servlets in the examples and testing contexts work as expected. Since Webware for Python 3 uses WSGI, WebTest can now also be used to test applications built with Webware for Python 3.
4343

4444
Otherwise, not much has been changed, so that migrating existing Webware for Python applications to Webware for Python 3 should be straight forward. Of course, you still need to migrate your Webware applications from `Python 2 to Python 3`_, but meanwhile a lot of tools and guidelines have been provided that help making this process as painless as possible.
4545

@@ -75,11 +75,12 @@ You can keep up on new releases through the very low traffic `announcement maili
7575
.. _ORM: https://en.wikipedia.org/wiki/Object-relational_mapping
7676
.. _SQLAlchemy: https://www.sqlalchemy.org/
7777
.. _MiddleKit for Webware for Python 3: https://github.com/WebwareForPython/w4py3-middlekit
78+
.. _twill: https://twill-tools.github.io/twill/
7879
.. _WebTest: https://docs.pylonsproject.org/projects/webtest/en/latest/
7980
.. _Python 2 to Python 3: https://docs.python.org/3/howto/pyporting.html
8081
.. _discussion mailing list: https://sourceforge.net/projects/webware/lists/webware-discuss
8182
.. _announcement mailing list: https://sourceforge.net/projects/webware/lists/webware-announce
82-
.. _GitHub project page: https://github.com/WebwareForPython/w4py3/
83+
.. _GitHub project page: https://github.com/WebwareForPython/w4py3
8384
.. _GitHub pages: https://webwareforpython.github.io/w4py3/
8485
.. _Read the Docs: https://webware-for-python-3.readthedocs.io/
8586
.. _issues: https://github.com/WebwareForPython/w4py3/issues

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
keywords='web framework servlets',
3838
url='https://webwareforpython.github.io/w4py3/',
3939
project_urls={
40-
'Source': 'https://github.com/WebwareForPython/w4py3/',
40+
'Source': 'https://github.com/WebwareForPython/w4py3',
4141
'Issues': 'https://github.com/WebwareForPython/w4py3/issues',
4242
'Documentation': 'https://webwareforpython.github.io/w4py3/',
4343
},

0 commit comments

Comments
 (0)