Skip to content

Commit 69f12cd

Browse files
abhinav-saxena-fractal31abhinav-saxena-fractal31
committed
Push test file.
1 parent 69afdce commit 69f12cd

File tree

1,529 files changed

+822268
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,529 files changed

+822268
-0
lines changed

Diff for: ‎CONTRIBUTING.rst

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Contributing to Warehouse
2+
=========================
3+
4+
As an open source project, Warehouse welcomes contributions of many forms.
5+
6+
Examples of contributions include:
7+
8+
* Code patches.
9+
* Documentation improvements.
10+
* Bug reports.
11+
* Patch reviews.
12+
13+
Extensive contribution guidelines are available in the repository at
14+
``docs/dev/index.rst`` or
15+
`online <https://warehouse.pypa.io/development/>`_.

Diff for: ‎Dockerfile

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
# First things first, we build an image which is where we're going to compile
2+
# our static assets with. We use this stage in development.
3+
FROM node:20.3.1-bullseye as static-deps
4+
5+
WORKDIR /opt/warehouse/src/
6+
7+
# However, we do want to trigger a reinstall of our node.js dependencies anytime
8+
# our package.json changes, so we'll ensure that we're copying that into our
9+
# static container prior to actually installing the npm dependencies.
10+
COPY package.json package-lock.json .babelrc /opt/warehouse/src/
11+
12+
# Installing npm dependencies is done as a distinct step and *prior* to copying
13+
# over our static files so that, you guessed it, we don't invalidate the cache
14+
# of installed dependencies just because files have been modified.
15+
RUN npm ci
16+
17+
18+
19+
20+
# This is our actual build stage, where we'll compile our static assets.
21+
FROM static-deps as static
22+
23+
# Actually copy over our static files, we only copy over the static files to
24+
# save a small amount of space in our image and because we don't need them. We
25+
# copy `webpack.config.js` last even though it's least likely to change, because
26+
# it's very small so copying it needlessly isn't a big deal but it will save a
27+
# small amount of copying when only `webpack.config.js` is modified.
28+
COPY warehouse/static/ /opt/warehouse/src/warehouse/static/
29+
COPY warehouse/admin/static/ /opt/warehouse/src/warehouse/admin/static/
30+
COPY webpack.config.js /opt/warehouse/src/
31+
32+
RUN NODE_ENV=production npm run build
33+
34+
35+
36+
37+
# We'll build a light-weight layer along the way with just docs stuff
38+
FROM python:3.11.4-slim-bullseye as docs
39+
40+
# Install System level build requirements, this is done before
41+
# everything else because these are rarely ever going to change.
42+
RUN set -x \
43+
&& apt-get update \
44+
&& apt-get install --no-install-recommends -y \
45+
build-essential git libcairo2-dev libfreetype6-dev libjpeg-dev libpng-dev libz-dev
46+
47+
# We create an /opt directory with a virtual environment in it to store our
48+
# application in.
49+
RUN set -x \
50+
&& python3 -m venv /opt/warehouse
51+
52+
# Now that we've created our virtual environment, we'll go ahead and update
53+
# our $PATH to refer to it first.
54+
ENV PATH="/opt/warehouse/bin:${PATH}"
55+
56+
# Next, we want to update pip, setuptools, and wheel inside of this virtual
57+
# environment to ensure that we have the latest versions of them.
58+
# TODO: We use --require-hashes in our requirements files, but not here, making
59+
# the ones in the requirements files kind of a moot point. We should
60+
# probably pin these too, and update them as we do anything else.
61+
RUN pip --no-cache-dir --disable-pip-version-check install --upgrade pip setuptools wheel
62+
63+
# We copy this into the docker container prior to copying in the rest of our
64+
# application so that we can skip installing requirements if the only thing
65+
# that has changed is the Warehouse code itself.
66+
COPY requirements /tmp/requirements
67+
68+
# Install the Python level Warehouse requirements, this is done after copying
69+
# the requirements but prior to copying Warehouse itself into the container so
70+
# that code changes don't require triggering an entire install of all of
71+
# Warehouse's dependencies.
72+
RUN set -x \
73+
&& pip --no-cache-dir --disable-pip-version-check \
74+
install --no-deps \
75+
-r /tmp/requirements/docs-dev.txt \
76+
-r /tmp/requirements/docs-user.txt \
77+
-r /tmp/requirements/docs-blog.txt \
78+
&& pip check \
79+
&& find /opt/warehouse -name '*.pyc' -delete
80+
81+
WORKDIR /opt/warehouse/src/
82+
83+
# We'll make the docs container run as a non-root user, ensure that the built
84+
# documentation belongs to the same user on the host machine.
85+
ARG USER_ID
86+
ARG GROUP_ID
87+
RUN groupadd -o -g $GROUP_ID -r docs
88+
RUN useradd -o -m -u $USER_ID -g $GROUP_ID docs
89+
RUN chown docs /opt/warehouse/src
90+
USER docs
91+
92+
93+
94+
95+
# Now we're going to build our actual application, but not the actual production
96+
# image that it gets deployed into.
97+
FROM python:3.11.4-slim-bullseye as build
98+
99+
# Define whether we're building a production or a development image. This will
100+
# generally be used to control whether or not we install our development and
101+
# test dependencies.
102+
ARG DEVEL=no
103+
104+
# To enable Ipython in the development environment set to yes (for using ipython
105+
# as the warehouse shell interpreter,
106+
# i.e. 'docker compose run --rm web python -m warehouse shell --type=ipython')
107+
ARG IPYTHON=no
108+
109+
# Install System level Warehouse build requirements, this is done before
110+
# everything else because these are rarely ever going to change.
111+
RUN set -x \
112+
&& apt-get update \
113+
&& apt-get install --no-install-recommends -y \
114+
build-essential libffi-dev libxml2-dev libxslt-dev libpq-dev libcurl4-openssl-dev libssl-dev \
115+
$(if [ "$DEVEL" = "yes" ]; then echo 'libjpeg-dev'; fi)
116+
117+
# We create an /opt directory with a virtual environment in it to store our
118+
# application in.
119+
RUN set -x \
120+
&& python3 -m venv /opt/warehouse
121+
122+
# Now that we've created our virtual environment, we'll go ahead and update
123+
# our $PATH to refer to it first.
124+
ENV PATH="/opt/warehouse/bin:${PATH}"
125+
126+
# Next, we want to update pip, setuptools, and wheel inside of this virtual
127+
# environment to ensure that we have the latest versions of them.
128+
# TODO: We use --require-hashes in our requirements files, but not here, making
129+
# the ones in the requirements files kind of a moot point. We should
130+
# probably pin these too, and update them as we do anything else.
131+
RUN pip --no-cache-dir --disable-pip-version-check install --upgrade pip setuptools wheel
132+
133+
# We copy this into the docker container prior to copying in the rest of our
134+
# application so that we can skip installing requirements if the only thing
135+
# that has changed is the Warehouse code itself.
136+
COPY requirements /tmp/requirements
137+
138+
# Install our development dependencies if we're building a development install
139+
# otherwise this will do nothing.
140+
RUN set -x \
141+
&& if [ "$DEVEL" = "yes" ]; then pip --no-cache-dir --disable-pip-version-check install -r /tmp/requirements/dev.txt; fi
142+
143+
RUN set -x \
144+
&& if [ "$DEVEL" = "yes" ] && [ "$IPYTHON" = "yes" ]; then pip --no-cache-dir --disable-pip-version-check install -r /tmp/requirements/ipython.txt; fi
145+
146+
# Install the Python level Warehouse requirements, this is done after copying
147+
# the requirements but prior to copying Warehouse itself into the container so
148+
# that code changes don't require triggering an entire install of all of
149+
# Warehouse's dependencies.
150+
RUN set -x \
151+
&& pip --no-cache-dir --disable-pip-version-check \
152+
install --no-deps \
153+
-r /tmp/requirements/deploy.txt \
154+
-r /tmp/requirements/main.txt \
155+
$(if [ "$DEVEL" = "yes" ]; then echo '-r /tmp/requirements/tests.txt -r /tmp/requirements/lint.txt'; fi) \
156+
&& pip check \
157+
&& find /opt/warehouse -name '*.pyc' -delete
158+
159+
160+
161+
162+
# Now we're going to build our actual application image, which will eventually
163+
# pull in the static files that were built above.
164+
FROM python:3.11.4-slim-bullseye
165+
166+
# Setup some basic environment variables that are ~never going to change.
167+
ENV PYTHONUNBUFFERED 1
168+
ENV PYTHONPATH /opt/warehouse/src/
169+
ENV PATH="/opt/warehouse/bin:${PATH}"
170+
171+
WORKDIR /opt/warehouse/src/
172+
173+
# Define whether we're building a production or a development image. This will
174+
# generally be used to control whether or not we install our development and
175+
# test dependencies.
176+
ARG DEVEL=no
177+
178+
# This is a work around because otherwise postgresql-client bombs out trying
179+
# to create symlinks to these directories.
180+
RUN set -x \
181+
&& mkdir -p /usr/share/man/man1 \
182+
&& mkdir -p /usr/share/man/man7
183+
184+
# Install System level Warehouse requirements, this is done before everything
185+
# else because these are rarely ever going to change.
186+
RUN set -x \
187+
&& apt-get update \
188+
&& apt-get install --no-install-recommends -y \
189+
libpq5 libxml2 libxslt1.1 libcurl4 \
190+
$(if [ "$DEVEL" = "yes" ]; then echo 'bash libjpeg62 postgresql-client build-essential libffi-dev libxml2-dev libxslt-dev libpq-dev libcurl4-openssl-dev libssl-dev vim'; fi) \
191+
&& apt-get clean \
192+
&& rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
193+
194+
# Copy the directory into the container, this is done last so that changes to
195+
# Warehouse itself require the least amount of layers being invalidated from
196+
# the cache. This is most important in development, but it also useful for
197+
# deploying new code changes.
198+
COPY --from=static /opt/warehouse/src/warehouse/static/dist/ /opt/warehouse/src/warehouse/static/dist/
199+
COPY --from=static /opt/warehouse/src/warehouse/admin/static/dist/ /opt/warehouse/src/warehouse/admin/static/dist/
200+
COPY --from=build /opt/warehouse/ /opt/warehouse/
201+
COPY . /opt/warehouse/src/

Diff for: ‎LICENSE

+174
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
https://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.

0 commit comments

Comments
 (0)