Instructions to install Python SDK from source

[Pablo Estrada <pa...@google.com>]

Hello all,
I noticed that the README for Beam has some basic instructions on
installing Beam from source using mvn. Do these instructions work also to
install Python SDK?
I have my own script to install the Python SDK from source reliably, but I
recently noticed that there's no instructions to install exclusively the
Python SDK within the Beam docs. (Or perhaps I missed it?)
I feel like we should document this better, so I was wondering what the
community thinks about:

1) Having a README file within sdks/python/ with this and other important
python documentation,
2) and/or only having an entry in the Beam docs.

Best
-P.
-- 
Got feedback? go/pabloem-feedback

Re: Instructions to install Python SDK from source

[María García Herrero <ma...@google.com>]

There used to be a README when the Python SDK was not yet in master. I
worked on it as my first contribution to Beam.
This is what it looked like the last time I touched it:

*https://github.com/apache/beam/pull/1726/files#diff-4fdc1cf711ab8b1a145ac7ebbe76d937
<https://github.com/apache/beam/pull/1726/files#diff-4fdc1cf711ab8b1a145ac7ebbe76d937>*Feel
free to reuse it,

María


On Wed, Feb 28, 2018 at 5:32 PM, Ahmet Altay <al...@google.com> wrote:

> Hi Pablo,
>
> You have a great point. Getting started instructions for developers for
> Python SDK is not well documented. Installing Python SDK from source is a
> subset of this lack of documentation. There is a JIRA for this (
> https://issues.apache.org/jira/browse/BEAM-3075). It would be great if
> you can take that and add some documentation. It could also contain
> information on running tests, setting up an IDE etc. I think it would be
> better to update the website as the single source of documentation, rather
> than having individual README files spread across our repository. It would
> also be more accessible for new developers coming into Beam.
>
> Thank you,
> Ahmet
>
> On Wed, Feb 28, 2018 at 4:23 PM, Pablo Estrada <pa...@google.com> wrote:
>
>> Hello all,
>> I noticed that the README for Beam has some basic instructions on
>> installing Beam from source using mvn. Do these instructions work also to
>> install Python SDK?
>> I have my own script to install the Python SDK from source reliably, but
>> I recently noticed that there's no instructions to install exclusively the
>> Python SDK within the Beam docs. (Or perhaps I missed it?)
>> I feel like we should document this better, so I was wondering what the
>> community thinks about:
>>
>> 1) Having a README file within sdks/python/ with this and other important
>> python documentation,
>> 2) and/or only having an entry in the Beam docs.
>>
>> Best
>> -P.
>> --
>> Got feedback? go/pabloem-feedback
>> <https://goto.google.com/pabloem-feedback>
>>
>
>


-- 

Impact is the effect that wouldn’t have happened if you hadn’t done what you
did.

Re: Instructions to install Python SDK from source

[Ahmet Altay <al...@google.com>]

Hi Pablo,

You have a great point. Getting started instructions for developers for
Python SDK is not well documented. Installing Python SDK from source is a
subset of this lack of documentation. There is a JIRA for this (
https://issues.apache.org/jira/browse/BEAM-3075). It would be great if you
can take that and add some documentation. It could also contain information
on running tests, setting up an IDE etc. I think it would be better to
update the website as the single source of documentation, rather than
having individual README files spread across our repository. It would also
be more accessible for new developers coming into Beam.

Thank you,
Ahmet

On Wed, Feb 28, 2018 at 4:23 PM, Pablo Estrada <pa...@google.com> wrote:

> Hello all,
> I noticed that the README for Beam has some basic instructions on
> installing Beam from source using mvn. Do these instructions work also to
> install Python SDK?
> I have my own script to install the Python SDK from source reliably, but I
> recently noticed that there's no instructions to install exclusively the
> Python SDK within the Beam docs. (Or perhaps I missed it?)
> I feel like we should document this better, so I was wondering what the
> community thinks about:
>
> 1) Having a README file within sdks/python/ with this and other important
> python documentation,
> 2) and/or only having an entry in the Beam docs.
>
> Best
> -P.
> --
> Got feedback? go/pabloem-feedback
> <https://goto.google.com/pabloem-feedback>
>