EPCPyYes API Documentation

The main purpose of this library is to allow developers to quickly build systems that parse, generate and store EPCIS data quickly and efficiently with a clear and straight-forward pythonic API.

The examples and usage section is also available as a Jupyter notebook and can be found in the docs directory within the root directory of the source code.

Examples and Usage

• Using the EPCPyYes Module
  • Python Classes That Generate Compliant XML and JSON
  • Get Jupyter
• Before You Try To Run This Code in Jupyter
  • Creating SGTIN URN Values
    • gtin_urn_generator helper function
    • gtin_to_urn helper function
    • Getting Time Values for Events with the get_current_utc_time_and_offset function
    • Converting a GLN to an SGLN URN Value with the gln13_data_to_sgln_urn function
• Generating EPCIS Events
  • Create Sample EPCs Using the Helpers
  • Creating a Basic Object Event
    • Using the CVB BusinessSteps and Disposition enumerations.
  • Adding a Business Location and Read Point
  • Adding Instance Lot Master Data (ILMD) to an Event
  • Adding Source and Destination Data to an Event
  • Creating an Aggregation Event
  • Adding a Transaction Event
  • Creating a Quantity List
• Using the New EventID and ErrorDeclaration
• Add a Transformation Event
• Create a Standard Business Document Header
  • Create sender and receiver partner ids
  • Create the Partner Instances for Sender and Reciever
  • Create the Document Identification and Header Class Instances
• Adding The Header and Events to an EPCIS Document
  • EPCISDocument Class
  • EPCISEventListDocument
• Extending The Templates

API Documentation

• EPCIS Event Modules
  • Core EPCIS Event Classes
  • EPCIS Template Classes
  • EPCIS Helper Functions
  • EPCIS Errors
• Core Business Vocabulary Modules
  • CBV Helper Functions
  • Business Steps (BizSteps)
  • Business Transactions (BizTransactions)
  • Dispositions
  • Error Reasons
  • Trade Item Master Data
  • Location Party Master Data
• EPCPYYes
• Pronounced “EPC-Pie-Yes”: Open source components for the GS1 EPCIS standard
  • Python to EPCIS XML or JSON
  • Fully Tested
  • Fully Documented
• Jupyter Notebook:
  • Jinja2 Templates for Creating and Transforming EPCIS Docs and Events
  • Core Classes
  • Helpers
    • Utilities that help you:
  • CBV 1.2 Type Support and Utilities

Installation and Contribution

• Installation
  • From sources
• Contributing
  • Types of Contributions
    • Report Bugs
    • Fix Bugs
    • Implement Features
    • Write Documentation
    • Submit Feedback
  • Get Started!
  • Pull Request Guidelines
  • Tips

Indices and tables

• Index

• Module Index

• Search Page