aws-samples / amazon-textract-idp-cdk-constructs

MIT No Attribution
27 stars 13 forks source link

[Doc] Explicit package distribution/install details #115

Open athewsey opened 5 months ago

athewsey commented 5 months ago

Hi there,

As I understand from the linked samples repository, the constructs here can be installed & used via pip install amazon-textract-idp-cdk-constructs - which is nicely logical & matching the GitHub name & etc...

But as a library user I'd never like to assume such a thing - in case of some malicious package name squatters somewhere.

So it'd be nice if this repository's README was nice and explicit, up top, about what registries users can install the package from?

If we're trying to save space / keep concise, I think a simple shields.io badge would be sufficient... For e.g. the constructs library does this - and for us it could look like:

PyPI Latest Release MarkDown Source: [![PyPI Latest Release](https://img.shields.io/pypi/v/amazon-textract-idp-cdk-constructs.svg)](https://pypi.org/project/amazon-textract-idp-cdk-constructs/)

...Or if somebody wanted to be more verbose, perhaps could have an explicit section on 'Installing' too? Like e.g. Pandas, SageMaker Python SDK, and Amazon Textract Response Parser do


In particular, I see also that https://www.npmjs.com/package/amazon-textract-idp-cdk-constructs exists and seems like it might be maintained by the repo author(s). Is that the case? If so, it'd be great to list that on the readme too for CDK TypeScript users.

The badge could look like npm Latest Release [![npm Latest Release](https://img.shields.io/npm/v/amazon-textract-idp-cdk-constructs.svg)](https://www.npmjs.com/package/amazon-textract-idp-cdk-constructs)

schadem commented 5 months ago

Fully agree. Btw, the constructs are written in TS/JSII and generate packages for Python, JS/TS and Java atm. https://constructs.dev/packages/amazon-textract-idp-cdk-constructs/v/0.0.41?lang=java

anjanvb commented 3 months ago

@athewsey do you mind getting a readme PR out for this? Thanks.