cbinckly/djextpkg-nginx repository overview

Python Package Manager for Orchid Extender - README code{white-space: pre-wrap;} span.smallcaps{font-variant: small-caps;} span.underline{text-decoration: underline;} div.column{display: inline-block; vertical-align: top; width: 50%;}

⁠The Python Package Manager for Orchid Extender

The Python Package Manager for Orchid Extender unlocks the full potential of Python for customizing Sage 300. It enables quick and easy management of the embedded Python installation used by Extender and supports installation of most of the 195,000 packages from the Python Packaging Index⁠ or any custom package from a version control system (VCS) repository.

⁠What is the problem?

Extender uses an embedded Python installation that does not include the usual executables or run in a standards compliant shell. This makes it difficult to leverage Python's package ecosystem when using Extender to customize Sage 300.

⁠How does it work?

The Python Package Manager for Orchid Extender makes it easy to install, uninstall, and retrieve the information for packages. It works by temporarily creating a fully functioning Python environment and using pip, the standard Python package manager, to manage the Extender Python installation.

⁠How do I get a copy?

You can download the latest version⁠. To use it the package manager you'll need a license. Request a seven day trial⁠.

⁠How do I install it?

The module must be installed and run as a Windows Administrator. Open the Sage desktop and navigate to Extender -> Setup. Open the Modules screen.

In the modules screen, click Import and select the VIEXTPKG.2665093.vi file. Once the import is complete, close the Modules screen.

From the Extender -> Setup menu, open the Custom Table Editor. In the Custom Table Editor, select the Python Package Manager Configuration table and click Load. Input your Client ID and click Add to save the entry.

That's it, you're all ready to go.

⁠How do I run it?

A new icon for the Python Package Manager is created in the Extender -> Setup menu when the module is installed.

The Python Package Manager can also be run by opening the Scripts screen from the Extender -> Setup menu, highlighting PackageManager.2665093 in the grid, and clicking Run.

⁠How do I use it?

The Package Manager creates a temporary Python environment on start up, which can take a minute or two. The first time you open the screen you may also be notified that pip is out of date and will be upgraded.

Once the Package Manager screen opens, you have a couple of choices.

⁠Install a New Package

Install a new package by filling in the Package Name and clicking 'Install'. The Python Package Manager automatically resolves and installs all required package dependencies.

You can also provide a VCS URI to any repository pip can install from. See VCS Support⁠ for more information.

Once the package installation completes an alert pops up with the result.

⁠Manage an Existing Package

When the Package Manager starts, it takes an inventory of all the packages installed. Any of these packages can be upgraded or uninstalled: simply select the package from the Installed Packages drop down and click 'Upgrade' or 'Uninstall'.

Once the action is complete an alert provides the result.

⁠What can I use it for?

Installing and removing packages! This alone unlocks lots of new opportunities for Extender.

⁠Leverage libraries

Need to parse an excel file⁠, do calculations with Julian Dates⁠, access a database⁠ or web service like AWS⁠? Maybe a little AI⁠ to perform dynamic validations?

Simply install a package from the Python Package Index and save yourself from recreating the wheel.

⁠Create your own

Create and publish your own libraries to keep DRY⁠ and maximize code re-use. Package code that you use frequently across scripts and re-use the code from your package to save time, improve maintainability, and deliver highly readable code focused on your customer's business logic.

This approach makes backporting bug-fixes to existing customers simple. Simply fix the code, publish a new version of the package, and upgrade the Package in one click using the Python Package Manager for Extender! No need to redistribute new module files.

Have a look at a new workflow for developing and deploying⁠ Extender scripts leveraging the Python Package Manager for Extender.

⁠VCS Support

Pip can install directly from a Version Control System. Supported systems include git, subversion, mercurial, and bazaar. This makes development and testing of packages much easier: install the package directly from the code repository in editable mode and upgrades will use the latest commit.

The Package Manager depends on pip, and can do all the things that pip can, so check out pip's docs on working with VCS⁠ for supported schemes and syntax.

Note that to download packages using a VCS the binaries or supporting libraries for the VCS must be installed seperately. At present, the SSH transport protocol is not supported.

⁠Debugging and Viewing the Log

Some packages cannot be installed. In particular, those that require custom extensions be compiled in place are not supported.

To figure out why a particular action failed, or just to see a transcript of the package actions performed, use the 'View Log' button. This will open the logs for the last two operations in the default viewer for text (.txt) files.

⁠Help!

If ever things aren't working as expected, a package you need won't install, or you accidentally uninstall pip (please, never do this), drop us a line and we will help to get you running.