-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1435 from PrefectHQ/org-062
Archive 0.6.2 documentation
- Loading branch information
Showing
60 changed files
with
5,099 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
--- | ||
sidebarDepth: 0 | ||
editLink: false | ||
--- | ||
|
||
|
||
<div align="center" style="margin-bottom:40px;"> | ||
<img src="/assets/wordmark-color-horizontal.svg" width=600 > | ||
</div> | ||
|
||
# API Reference | ||
|
||
This API reference is automatically generated from Prefect's source code and unit-tested to ensure it's up to date. | ||
|
||
|
||
## Hello, world! 👋 | ||
|
||
We've rebuilt data engineering for the data science era. | ||
|
||
Prefect is a new workflow management system, designed for modern infrastructure and powered by the open-source Prefect Core workflow engine. Users organize `Tasks` into `Flows`, and Prefect takes care of the rest. | ||
|
||
Read the [docs](https://docs.prefect.io); get the [code](#installation); ask us [anything](https://join.slack.com/t/prefect-public/shared_invite/enQtNzE5OTU3OTQwNzc1LTQ5M2FkZmQzZjI0ODg1ZTBmOTc0ZjVjYWFjMWExZDAyYzBmYjVmMTE1NTQ1Y2IxZTllOTc4MmI3NzYxMDlhYWU)! | ||
|
||
```python | ||
from prefect import task, Flow | ||
|
||
|
||
@task | ||
def say_hello(): | ||
print("Hello, world!") | ||
|
||
|
||
with Flow("My First Flow") as flow: | ||
say_hello() | ||
|
||
|
||
flow.run() # "Hello, world!" | ||
``` | ||
|
||
## Docs | ||
|
||
Prefect's documentation -- including concepts, tutorials, and a full API reference -- is always available at [docs.prefect.io](https://docs.prefect.io). | ||
|
||
Instructions for contributing to documentation can be found in the [development guide](https://docs.prefect.io/guide/development/documentation.html). | ||
|
||
## Contributing | ||
|
||
Read about Prefect's [community](https://docs.prefect.io/guide/welcome/community.html) or dive in to the [development guides](https://docs.prefect.io/guide/development/overview.html) for information about contributions, documentation, code style, and testing. | ||
|
||
Join our [Slack](https://join.slack.com/t/prefect-public/shared_invite/enQtNzE5OTU3OTQwNzc1LTQ5M2FkZmQzZjI0ODg1ZTBmOTc0ZjVjYWFjMWExZDAyYzBmYjVmMTE1NTQ1Y2IxZTllOTc4MmI3NzYxMDlhYWU) to chat about Prefect, ask questions, and share tips. | ||
|
||
Prefect is committed to ensuring a positive environment. All interactions are governed by our [Code of Conduct](https://docs.prefect.io/guide/welcome/code_of_conduct.html). | ||
|
||
## "...Prefect?" | ||
|
||
From the Latin _praefectus_, meaning "one who is in charge", a prefect is an official who oversees a domain and makes sure that the rules are followed. Similarly, Prefect is responsible for making sure that workflows execute properly. | ||
|
||
It also happens to be the name of a roving researcher for that wholly remarkable book, _The Hitchhiker's Guide to the Galaxy_. | ||
|
||
## Installation | ||
|
||
### Requirements | ||
|
||
Prefect requires Python 3.5.2+. | ||
|
||
### Install latest release | ||
|
||
Using `pip`: | ||
|
||
```bash | ||
pip install prefect | ||
``` | ||
|
||
or `conda`: | ||
|
||
```bash | ||
conda install -c conda-forge prefect | ||
``` | ||
|
||
or `pipenv`: | ||
``` | ||
pipenv install --pre prefect | ||
``` | ||
|
||
### Install bleeding edge | ||
|
||
```bash | ||
git clone https://github.com/PrefectHQ/prefect.git | ||
pip install ./prefect | ||
``` | ||
|
||
## License | ||
|
||
Prefect is licensed under the Apache Software License version 2.0. | ||
<p class="auto-gen">This documentation was auto-generated from commit <a href='https://github.com/PrefectHQ/prefect/commit/n/a'>n/a</a> </br>on August 30, 2019 at 22:53 UTC</p> |
Oops, something went wrong.