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.

Sign up for GitHub

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

Add API token instructions to confirmation section #6615

Merged
merged 5 commits into from
Sep 22, 2019
Merged

Add API token instructions to confirmation section #6615

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c40aaa1
Add API token instructions to confirmation section
nlhkabu Sep 11, 2019
348fa99
Add translation blocks
nlhkabu Sep 15, 2019
0f83a08
Improve translation blocks
nlhkabu Sep 15, 2019
41aefc7
Fix multiline pre blocks
di Sep 22, 2019
6651ffb
Merge branch 'master' into token-instructions
nlhkabu Sep 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions warehouse/static/sass/blocks/_api-token.scss → ...house/static/sass/blocks/_code-block.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,18 @@
*/

/*
A custom styled code block for API tokens.
A custom styled code block.

<code class="api-token">
Token here
<code class="code-block">
Code here
</code>

<pre class="code-block">
Code here
</pre>
*/

.api-token {
.code-block {
display: block;
padding: $spacing-unit / 2;
margin-bottom: $spacing-unit / 2;
Expand Down
2 changes: 1 addition & 1 deletion warehouse/static/sass/warehouse.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@
// blocks LAYER: some warehouse specific, some generic/reusable
@import "blocks/about-pypi";
@import "blocks/accordion";
@import "blocks/api-token";
@import "blocks/applied-filters";
@import "blocks/author-profile";
@import "blocks/badge";
Expand All @@ -75,6 +74,7 @@
@import "blocks/callout-block";
@import "blocks/centered-heading";
@import "blocks/checkbox-tree";
@import "blocks/code-block";
@import "blocks/dark-overlay";
@import "blocks/dropdown";
@import "blocks/faq-group";
Expand Down
51 changes: 47 additions & 4 deletions warehouse/templates/manage/token.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ <h2>{% trans macaroon_description=macaroon.description %}Token for "{{ macaroon_
<strong>{% trans %}Scope:{% endtrans %}</strong> {% trans project=macaroon.caveats.permissions.projects[0] %}Project "{{ project }}"{% endtrans %}
{% endif %}
</p>
<p>{% trans href='/help#apitoken' %}For instructions on how to use this token, <a href="{{ href }}">visit the PyPI help page</a>.{% endtrans %}</p>
<code class="api-token">{{ serialized_macaroon }}</code>

<code class="code-block">{{ serialized_macaroon }}</code>
<div class="margin-bottom--large">
<div class="callout-block callout-block--danger no-top-margin">
<p>{% trans %}For security reasons this token will only appear once. <strong>Copy it now.</strong>{% endtrans %}</p>
Expand All @@ -61,8 +61,51 @@ <h2>{% trans macaroon_description=macaroon.description %}Token for "{{ macaroon_

{{ confirm_modal(title=title, confirm_name=gettext("Username"), confirm_string=user.username, confirm_button_label=confirm_button_label, slug=slug, extra_fields=extra_fields, custom_warning_text=token_warning_text, confirm_string_in_title=False) }}
</div>
<hr>

<h2>{% trans %}Using this token{% endtrans %}</h2>

<p>{% trans %}To use this API token:{% endtrans %}</p>

<ul>
<li>{% trans token='__token__' %}Set your username to <code>{{ token }}</code>{% endtrans %}</li>
<li>{% trans prefix='pypi-' %}Set your password to the token value, including the <code>{{ prefix }}</code> prefix{% endtrans %}</li>
</ul>

{% if macaroon.caveats.permissions == "user" %}

<p>
{% trans trimmed href='https://pypi.org/project/virtualenv/', filename='$HOME/.pypirc' %}
For example, if you are using <a href="{{ href }}">Twine</a> to upload your projects to PyPI, set up your <code>{{ filename }}</code> file like this:
{% endtrans %}
</p>
<pre class="code-block">
[pypi]
username = __token__
password = {{ serialized_macaroon }}</pre>
{% else %}
<p>
{% trans trimmed href='https://pypi.org/project/virtualenv/', filename='$HOME/.pypirc' %}
For example, if you are using <a href="{{ href }}">Twine</a> to upload multiple projects to PyPI, you can set up your <code>{{ filename }}</code> file like this:
{% endtrans %}
</p>
<pre class="code-block">
[pypi]
username = __token__
password = # {% trans %}either a user-scoped token or a project-scoped token you want to set as the default{% endtrans %}

[PROJECT_NAME]
username = __token__
password = # {% trans %}a project token{% endtrans %} </pre>
<p>
{% trans trimmed command='twine --repository PROJECT_NAME' %}
You can then use <code>{{ command }}</code> to switch to the correct token when uploading to PyPI.
{% endtrans %}
</p>
{% endif %}

<p>{% trans href='/help#apitoken' %}For further instructions on how to use this token, <a href="{{ href }}">visit the PyPI help page</a>.{% endtrans %}</p>
</section>
<hr>
{% endif %}

{{ form_error_anchor(create_macaroon_form) }}
Expand Down Expand Up @@ -111,7 +154,7 @@ <h2>{% trans %}Add another token{% endtrans %}</h2>
</div>
<div id="api-token-scope-warning" class="callout-block callout-block--warning" hidden>
<h3 class="callout-block__heading">{% trans %}Proceed with caution!{% endtrans %}</h3>
<p>{% trans %}An API token scoped to your entire account will have upload permissions for all of your projects.{% endtrans %}</p>
<p>{% trans %}An API token scoped to your entire account will have upload permissions for all of your current and future projects.{% endtrans %}</p>
</div>
<div>
<input value="{% trans %}Add token{% endtrans %}" class="button button--primary" type="submit">
Expand Down