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

Bundle fixes and documentation improvements #2733

Merged
merged 4 commits into from Jul 22, 2020
Merged

Conversation

llllllllll
Copy link
Contributor

  • make quantopian-quandl the default bundle
  • update documentation to reflect new default bundle
  • update documentation to make quandl bundle as deprecated
  • improve error message when no benchmark is provided

@coveralls
Copy link

coveralls commented Jul 16, 2020

Coverage Status

Coverage decreased (-0.02%) to 88.195% when pulling a23ed2d on bundle-doc-improvements into 0e0b9ec on master.

docs/source/bundles.rst Outdated Show resolved Hide resolved
zipline/__main__.py Outdated Show resolved Hide resolved
docs/source/bundles.rst Show resolved Hide resolved
By default zipline comes with the ``quandl`` data bundle which uses quandl's
`WIKI dataset <https://www.quandl.com/data/WIKI>`_. The quandl data bundle
includes daily pricing data, splits, cash dividends, and asset metadata. To
ingest the ``quandl`` data bundle we recommend creating an account on quandl.com
Copy link
Member

Choose a reason for hiding this comment

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

Should we still document the quandl bundle somewhere?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think this bundle will still work, so we can remove it from the docs.

docs/source/bundles.rst Outdated Show resolved Hide resolved
@@ -140,6 +140,13 @@
AttachedPipeline = namedtuple('AttachedPipeline', 'pipe chunks eager')


class NoBenchmark(ValueError):
def __init__(self):
super().__init__(
Copy link
Member

Choose a reason for hiding this comment

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

Reminder for py2 compat (for this release)

}
).run()
except NoBenchmark:
raise _RunAlgoError(
Copy link
Member

Choose a reason for hiding this comment

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

Nice use of _RunAlgoError. I hadn't remembered this existed.

zipline/utils/run_algo.py Outdated Show resolved Hide resolved
zipline/utils/run_algo.py Outdated Show resolved Hide resolved
@richafrank
Copy link
Member

richafrank commented Jul 21, 2020

xref #2603
#2628

Co-authored-by: Richard Frank <richafrank@users.noreply.github.com>
@llllllllll llllllllll merged commit b46a801 into master Jul 22, 2020
@llllllllll llllllllll deleted the bundle-doc-improvements branch July 22, 2020 20:08
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.

None yet

3 participants