diff --git a/.github/workflows/python_publish.yml b/.github/workflows/python_publish.yml index 212d367f..be7d1c1d 100644 --- a/.github/workflows/python_publish.yml +++ b/.github/workflows/python_publish.yml @@ -1,17 +1,13 @@ name: Upload Python Package on: - push: - branches: - - master - paths: - - '/emanifest-py/pyproject.toml' + # Trigger the workflow only manually. workflow_dispatch: - + defaults: run: working-directory: emanifest-py - + jobs: deploy: runs-on: ubuntu-latest @@ -26,7 +22,7 @@ jobs: python-version: '3.x' - name: Install dependencies - run : | + run: | pip install --upgrade pip pip install build twine diff --git a/README.md b/README.md index a944d3f1..a6798179 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,20 @@ # e-Manifest -**Attention: New services documentation is under construction at https://usepa.github.io/e-manifest/ and will be -available soon** +**You can find our new services documentation +at [https://usepa.github.io/e-manifest/](https://usepa.github.io/e-manifest/)** ## Background -The overarching purpose of e-Manifest is to establish a national information technology system that will enable the +The purpose of e-Manifest is to establish a national information technology system that will enable the Agency and the hazardous waste program’s industry and state stakeholders to transition the manifest system from one that is paper-intensive and burdensome to a system that is much more efficient, because it will rely on information technology to track hazardous waste shipments. -## Frequently Asked Questions - -The e-Manifest team has uploaded an **[Updated FAQ](https://www.epa.gov/e-manifest/frequent-questions-about-e-manifest)**. - ## What is going on -The release calendar can be found -here: **[Release Calendar](https://calendar.google.com/calendar/u/0/htmlembed?src=cbg29nj98u94np3c4pp5vjdph8@group.calendar.google.com&ctz=America/New_York)** +See +our [Release Calendar](https://calendar.google.com/calendar/u/0/htmlembed?src=cbg29nj98u94np3c4pp5vjdph8@group.calendar.google.com&ctz=America/New_York) +for an at-a-glance view of upcoming changes. For more details on current issues see our [Issues page](https://github.com/USEPA/e-manifest/issues) @@ -26,23 +23,7 @@ For more details on current issues see our [Issues page](https://github.com/USEP document to see how the e-Manifest team utilizes GitHub issues to communicate what we are working on with the user community. -## How to test and what is available - -There are eleven categories of services available based on your user status: - -1. [All users] Authentication services -2. [All users] e-Manifest Lookup Services -3. [All users] Lookup Services -4. [All users] Site Services -5. [All users] User Services -6. [Industry users] e-Manifest Services -7. [Industry users] e-Manifest UI Link Services -8. [Regulator users] CM&E Evaluation Services -9. [Regulator users] e-Manifest Services -10. [Regulator users] Handler Services -11. [Regulator users] User Services - -**Tools for Testers** +## Tools for Developers and Testers - [JSON Schema](https://github.com/USEPA/e-manifest/tree/master/Services-Information/Schema) - [Sample JSON](https://github.com/USEPA/e-manifest/tree/master/Services-Information/Schema/manifest-save-return-examples) @@ -63,74 +44,22 @@ There are eleven categories of services available based on your user status: - [Swagger page](https://rcrainfopreprod.epa.gov/rcrainfo/secured/swagger/) for testing and documenting the services - You must be registered as a site manager for a TSDF site to access this site. See "Accessing the Test Environment" below. -- [Sample Client](https://github.com/USEPA/e-manifest/tree/master/Services-Information/sample-client) for accessing the - services -- Python [**emanifest**](https://github.com/USEPA/e-manifest/tree/master/emanifest-py) package for accessing the - services - -Please note: The test environment for the most part mirrors the handler information in our production environment. When -testing, please also make sure your site information is up to date. If it is not, please use myRCRAid or your state’s -paper notification process to update your site in the production environment. +- [Haztrak](https://github.com/USEPA/haztrak) open-source application for electronic manifesting +- [Sample Java application](https://github.com/USEPA/e-manifest/tree/master/sample-client) +- [Python Client Library](https://github.com/USEPA/e-manifest/tree/master/emanifest-py) +- [Typescript Client Library](https://github.com/USEPA/e-manifest/tree/master/emanifest-js) ## Accessing the Test Environment -**Registration:** - In order to access the test environment, all users will be required to set up a test account on the [test site](https://rcrainfopreprod.epa.gov/rcrainfo/). If you are interested in testing services, please -read [our services documentation](https://github.com/USEPA/e-manifest/tree/master/Services-Information). Please note, +read [our services docs](https://usepa.github.io/e-manifest/Intro/registration.html#user-registration). Please note, this test user account will be used for this review and all subsequent reviews and/or testing of e-Manifest software. -**User Registration:** - -Visit the [test site](https://rcrainfopreprod.epa.gov/rcrainfo/) - -- Click the "Register" link. -- Click the "Continue to Industry User Registration" button -- Create a CDX user ID and enter in your email address that you will use (or have) in the login.gov test environment -- Agree to the terms and conditions and click the Continue to LOGIN.GOV -- In Login.gov, follow the prompts and establish your multi-factor authentication methods -- Click the "Agree and continue" button which will take you back to RCRAInfo -- Verify your email -- Complete setting up your RCRAInfo account -- Click the "Complete Registration" -- You will be taken to the My Sites page to register your handler(s) - -**Handler Registration:** - -If your state is participating in approving e-Manifest test users, you may request access to your handler ID(s). -Otherwise, please register to use one of our test sites: - -| Site ID | Site Name | State | Zip | Type of Site | Notes | -| ------------ | ------------------------ | -------- | ----- | ---------------------- | ------------------------------------ | -| VA988177803 | HEATING AND OIL | Virginia | 22033 | Generator only | | -| VATEST000001 | TEST TRANSPORTER 1 OF VA | Virginia | 22202 | Generator, Transporter | | -| VATEST000002 | TEST TRANSPORTER 2 OF VA | Virginia | 22202 | Generator, Transporter | | -| VAD000532119 | TEST TSDF OF VA | Virginia | 22202 | Generator, TSDF | Can be used for testing web services | -| VATEST000003 | TEST TSDF OF VA TWO | Virginia | 22202 | Generator, TSDF | Can be used for testing web services | -| VATEST000004 | TEST GENERATOR OF VA | Virginia | 22202 | Generator only | | - -- On the My Sites page, click on the "Add Existing Site" button -- Search for your EPA ID number in the Site ID box or a test site and then select that facility.(For example: - VA000532119) -- Request a role for the site - - The 'Site Manager' Role will allow you to use the API services. -- After you submit your request, the request will go to your state or an EPA administrator. Please understand this is - not an instant access process and the administrator will need to manually activate your request during normal business - hours. - - Once you have completed this registration you may use either https://test.epacdx.net/ or https://rcrainfopreprod.epa.gov/rcrainfo/ to log on to the application. -**Obtaining an API Key** - -If you want to register for an API ID and key to test the services, you may create one by clicking on the 'Tools' menu -and selecting API. The API page will allow you to generate your unique API ID and key. The API ID and Key can be used to -access our web services which are documented on -the [Services Information page](https://github.com/USEPA/e-manifest/tree/master/Services-Information) and, if logged -into e-Manifest, on [Swagger](https://rcrainfopreprod.epa.gov/rcrainfo/secured/swagger/) - -**Upcoming Iterations** +## Upcoming Iterations In the upcoming months, we will add more screens and request feedback from States, Brokers, and Transporters. In addition, we will also release new versions of our Application Programming Interfaces (APIs) for users wishing to @@ -138,24 +67,16 @@ implement e-Manifest in their existing manifest systems. ## Reference -EPA's [Hazardous Waste Electronic Manifest System (e-Manifest)](https://www.epa.gov/hwgenerators/hazardous-waste-electronic-manifest-system-e-manifest) -page +EPA's [e-Manifest homepage](https://www.epa.gov/e-manifest) All our [active cards and issues](https://github.com/USEPA/e-manifest/issues) are posted in this GitHub Repository. We will be posting additional documents as well as issues that we want user feedback on in the near future. -Additional Resources: - -[Sample Paper Manifest](https://www.epa.gov/sites/production/files/2018-05/documents/uniform_hazardous_waste_manifest.pdf) - -[Paper Manifest Instructions](https://www.epa.gov/sites/production/files/2018-05/documents/instructions_for_completing_the_uniform_hazardous_waste_manifest.pdf) +[Sample paper manifest, continuation sheet, and instructions](https://www.epa.gov/hwgenerators/uniform-hazardous-waste-manifest-instructions-sample-form-and-continuation-sheet) ## Contact Information -Additional Questions: emanifest@epa.gov - -If you're interested in contributing to this project, -see [CONTRIBUTING.md](https://github.com/USEPA/e-manifest/blob/master/CONTRIBUTING.md) +Additional Questions: [email emanifest@epa.gov](mailto:emanifest@epa.gov) **Join the conversation and keep up on the latest e-Manifest news** diff --git a/docs/src/Intro/registration.md b/docs/src/Intro/registration.md index cd7ba013..8847edc8 100644 --- a/docs/src/Intro/registration.md +++ b/docs/src/Intro/registration.md @@ -21,17 +21,17 @@ requesting access to the EPA sites that you are working for. ### Obtain Site Access -The RCRAInfo test site has a number of EPA sites that you can request access to for testing purposes. The following -table sites are available for testing: - -| Site ID | Site Name | State | Zip | Site Type | Notes | -| ------------ | ------------------------ | -------- | ----- | ---------------------- | ----- | -| VA988177803 | HEATING AND OIL | Virginia | 22033 | Generator only | | -| VATEST000001 | TEST TRANSPORTER 1 OF VA | Virginia | 22202 | Generator, Transporter | | -| VATEST000002 | TEST TRANSPORTER 2 OF VA | Virginia | 22202 | Generator, Transporter | | -| VAD000532119 | TEST TSDF OF VA | Virginia | 22202 | Generator, TSDF | | -| VATEST000003 | TEST TSDF OF VA TWO | Virginia | 22202 | Generator, TSDF | | -| VATEST000004 | TEST GENERATOR OF VA | Virginia | 22202 | Generator only | | +If your state is participating in approving e-Manifest test users, you may request access to your handler ID(s). +Otherwise, please register to use one of our test sites: + +| Site ID | Site Name | State | Zip | Type of Site | Notes | +| ------------ | ------------------------ | -------- | ----- | ---------------------- | ------------------------------------ | +| VA988177803 | HEATING AND OIL | Virginia | 22033 | Generator only | | +| VATEST000001 | TEST TRANSPORTER 1 OF VA | Virginia | 22202 | Generator, Transporter | | +| VATEST000002 | TEST TRANSPORTER 2 OF VA | Virginia | 22202 | Generator, Transporter | | +| VAD000532119 | TEST TSDF OF VA | Virginia | 22202 | Generator, TSDF | Can be used for testing web services | +| VATEST000003 | TEST TSDF OF VA TWO | Virginia | 22202 | Generator, TSDF | Can be used for testing web services | +| VATEST000004 | TEST GENERATOR OF VA | Virginia | 22202 | Generator only | | - On the My Sites page, click on the "Add Existing Site" button @@ -39,13 +39,22 @@ table sites are available for testing: VA000532119) - Request a role for each module for this site. The roles are: - - Site Manager + - Site Manager (can use our web services) - Certifier - Preparer - Viewer The Site Manager role is the equivalent to having the Certifier role in each RCRAInfo module, and also has the ability -to -add and remove users from the site, and generate an API ID and key. +to add and remove users from the site, and generate an API ID and key. + +After you submit your request, the request will go to your state or an EPA administrator. Please understand this is +not an instant access process and the administrator will need to manually activate your request during normal business +hours. + +### Obtaining an API ID and Key + +If you want to register for an API ID and key to test the services, you may create one by clicking on the 'Tools' menu +and selecting API. You can use the [Swagger](https://rcrainfopreprod.epa.gov/rcrainfo/secured/swagger/) page to test +without your API ID and key. {{#include ../components/footer.md}} diff --git a/docs/src/Services/index.md b/docs/src/Services/index.md index 179eb336..b3c7c18b 100644 --- a/docs/src/Services/index.md +++ b/docs/src/Services/index.md @@ -7,14 +7,14 @@ The service. The services are secured using a [token-based authentication system 1. [All users] [Authentication services](authentication.md) 2. [All users] [e-Manifest Lookup Services](./Lookup/e-manifest-lookup.md) 3. [All users] [Lookup Services](./Lookup/lookup.md) -4. [All users] Site Services -5. [All users] User Services +4. [All users] [Site Services](./Site) +5. [All users] [User Services](./user.md) 6. [Industry users] [e-Manifest Services](Manifest/save.md) 7. [Industry users] [e-Manifest UI Link Services](./Manifest/ui-link.md) 8. [Regulator users] CM&E Evaluation Services 9. [Regulator users] [e-Manifest Services](Manifest/states.md) -10. [Regulator users] [Handler Services](./site-handler.md) -11. [Regulator users] User Services +10. [Regulator users] [Handler Services](./Site) +11. [Regulator users] [User Services](./user.md) ## Base URL