Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added an example for Arroyo usage. #44

Merged
merged 14 commits into from
Mar 10, 2022
Merged

Conversation

rahul-kumar-saini
Copy link
Contributor

  • There is limited documentation and (simple) examples for Arroyo's usage
  • Created an example for usage while learning to work with Arroyo and documented thoroughly.

@rahul-kumar-saini rahul-kumar-saini requested a review from a team as a code owner March 4, 2022 20:03
Copy link
Member

@lynnagara lynnagara left a comment

Choose a reason for hiding this comment

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

I would like to avoid increasing the size of the library due to the examples, can you please check that these are being excluded from the package?

arroyo/examples/transform_and_produce/README.md Outdated Show resolved Hide resolved
arroyo/examples/transform_and_produce/factory.py Outdated Show resolved Hide resolved
arroyo/examples/transform_and_produce/factory.py Outdated Show resolved Hide resolved
arroyo/examples/transform_and_produce/produce_step.py Outdated Show resolved Hide resolved
arroyo/examples/transform_and_produce/script.py Outdated Show resolved Hide resolved
arroyo/examples/transform_and_produce/script.py Outdated Show resolved Hide resolved
arroyo/examples/transform_and_produce/script.py Outdated Show resolved Hide resolved
arroyo/examples/transform_and_produce/produce_step.py Outdated Show resolved Hide resolved
arroyo/examples/transform_and_produce/produce_step.py Outdated Show resolved Hide resolved
@lynnagara
Copy link
Member

I would like to avoid increasing the size of the library due to the examples, can you please check that these are being excluded from the package?

Any thoughts on this @rahul-kumar-saini?

@rahul-kumar-saini
Copy link
Contributor Author

I would like to avoid increasing the size of the library due to the examples, can you please check that these are being excluded from the package?

Any thoughts on this @rahul-kumar-saini?

I've updated setup.py to exclude the examples module so it should not be part of the package now.

packages=find_packages(exclude=["tests", "arroyo.examples"]),

I attempted to bring the /examples folder out to the root directory but I'm getting a strange error: ModuleNotFoundError: No module named 'examples.transform_and_produce'

I've created __init__.py files in all directories that need it, and I believe the modules are recognized at compile time but not at runtime for some reason.

@lynnagara
Copy link
Member

I would like to avoid increasing the size of the library due to the examples, can you please check that these are being excluded from the package?

Any thoughts on this @rahul-kumar-saini?

I've updated setup.py to exclude the examples module so it should not be part of the package now.

packages=find_packages(exclude=["tests", "arroyo.examples"]),

I attempted to bring the /examples folder out to the root directory but I'm getting a strange error: ModuleNotFoundError: No module named 'examples.transform_and_produce'

I've created __init__.py files in all directories that need it, and I believe the modules are recognized at compile time but not at runtime for some reason.

Thanks, this seems fine where it is now.

Copy link
Member

@lynnagara lynnagara left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thanks for kicking off examples 🎉

@rahul-kumar-saini rahul-kumar-saini merged commit b7e4e44 into main Mar 10, 2022
@rahul-kumar-saini rahul-kumar-saini deleted the rahul/learn-arroyo branch March 10, 2022 21:02
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.

2 participants