Skip to content

Conversation

@Coniferish
Copy link
Contributor

@Coniferish Coniferish commented Jan 30, 2024

Partial solution to #30
This PR creates new make commands, including make run-jupyter for starting a local notebook. The notebook that's created runs the example code from the README (this is manually copied from the README, so this may become outdated in time). The README assumes you are actually in the unstructured-api directory, but the file referenced in the notebook is in a newly created directory for this repo.

This PR also starts using an underscore before directories that are human-written and adds those directories to the .genignore file.

NOTE: this PR sets up a pattern of managing dependencies through the MAKEFILE. Since setup.py isn't a document that we can reliably edit since it is auto-generated, requirements are added to the MAKEFILE and users should run make install to install packages needed for local development (such as jupyter).

This PR also creates a decorator for modifying the server_url that users pass to UnstructuredClient. This decorator removes the /general/v0/general path that is sometimes incorrectly added and fixes the http/https scheme.

@Coniferish Coniferish force-pushed the jj/decorators branch 2 times, most recently from c76c8c9 to bcfea6c Compare January 30, 2024 17:48
@Coniferish Coniferish changed the title WIP chore: init jupyter notebook for testing README examples Jan 30, 2024
@Coniferish Coniferish requested a review from awalker4 January 30, 2024 17:51
@Coniferish Coniferish marked this pull request as ready for review January 30, 2024 17:51
@Coniferish Coniferish force-pushed the jj/decorators branch 2 times, most recently from 5e77630 to 68a834e Compare February 5, 2024 16:42
@Coniferish Coniferish requested a review from scanny February 5, 2024 16:46
@Coniferish Coniferish changed the title chore: init jupyter notebook for testing README examples jupyter notebook and decorator to change server_url Feb 5, 2024
@Coniferish Coniferish requested a review from qued February 5, 2024 16:48
@Coniferish Coniferish changed the title jupyter notebook and decorator to change server_url add jupyter notebook and decorator to change server_url Feb 5, 2024
Copy link

@scanny scanny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Collaborator

@awalker4 awalker4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM pending one comment!

@Coniferish Coniferish merged commit 94e71aa into main Feb 5, 2024
@Coniferish Coniferish deleted the jj/decorators branch February 5, 2024 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants