1=======
2Artwork
3=======
4
5.. figure:: images/logo-over-white.svg
6   :align: center
7
8   Setuptools logo, designed in 2021 by `Anderson Bravalheri`_
9
10Elements of Design
11==================
12
13The main colours of the design are a dark pastel azure (``#336790``) and a pale
14orange (``#E5B62F``), referred in this document simply as "blue" and "yellow"
15respectively. The text uses the *Monoid* typeface, an open source webfont that
16was developed by Andreas Larsen and contributors in 2015 and is distributed
17under the MIT or SIL licenses (more information at
18https://github.com/larsenwork/monoid)
19
20
21Usage
22=====
23
24The preferred way of using the setuptools logo is over a white (or light)
25background. Alternatively, the following options can be considered, depending
26on the circumstances:
27
28- *"negative"* design - for dark backgrounds (e.g. website displayed in "dark
29  mode"): the white colour (``#FFFFFF``) of the background and the "blue"
30  (``#336790``) colour of the design can be swapped.
31- *"monochrome"* - when colours are not available (e.g. black and white printed
32  media): a completely black or white version of the logo can also be used.
33- *"banner"* mode: the symbol and text can be used alongside depending on the
34  available space.
35
36The following image illustrate these alternatives:
37
38.. image:: images/logo-demo.svg
39   :align: center
40
41Please refer to the SVG files in the `setuptools repository`_ for the specific
42shapes and proportions between the elements of the design.
43
44
45Working with the Design
46=======================
47
48The `setuptools repository`_ contains a series of vector representations of the
49design under the ``docs/images`` directory. These representations can be
50manipulated via any graphic editor that support SVG files,
51however the free and open-source software Inkscape_ is recommended for maximum
52compatibility.
53
54When selecting the right file to work with, file names including
55``editable-inkscape`` indicate "more editable" elements (e.g. editable text),
56while the others prioritise SVG paths for maximum reproducibility.
57
58Also notice that you might have to `install the correct fonts`_ to be able to
59visualise or edit some of the designs.
60
61
62Inspiration
63===========
64
65This design was inspired by :user:`cajhne`'s `original proposal`_ and the
66ancient symbol of the ouroboros_.
67It features a snake moving in a circular trajectory not only as a reference to
68the Python programming language but also to the `wheel package format`_ as one
69of the distribution formats supported by setuptools.
70The shape of the snake also resembles a cog, which together with the hammer is
71a nod to the two words that compose the name of the project.
72
73
74License
75=======
76
77
78This logo, design variations or a modified version may be used by anyone to
79refer to setuptools, but does not indicate endorsement by the project.
80
81Redistribution, usage and derivative works are permitted under the same license
82used by the setuptools software (MIT):
83
84.. code-block:: text
85
86   Copyright (c) Anderson Bravalheri
87
88   Permission is hereby granted, free of charge, to any person obtaining a copy
89   of this software and associated documentation files (the "Software"), to
90   deal in the Software without restriction, including without limitation the
91   rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
92   sell copies of the Software, and to permit persons to whom the Software is
93   furnished to do so, subject to the following conditions:
94
95   The above copyright notice and this permission notice shall be included in
96   all copies or substantial portions of the Software.
97
98   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
99   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
100   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
101   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
102   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
103   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
104   IN THE SOFTWARE.
105
106   THE USAGE OF THIS LOGO AND ARTWORK DOES NOT INDICATE ENDORSEMENT BY THE
107   SETUPTOOLS PROJECT.
108
109Whenever possible, please make the image a link to
110https://github.com/pypa/setuptools or https://setuptools.pypa.io.
111
112
113.. _Anderson Bravalheri: https://github.com/abravalheri
114.. _Inkscape: https://inkscape.org
115.. _setuptools repository: https://github.com/pypa/setuptools
116.. _install the correct fonts: https://wiki.inkscape.org/wiki/Installing_fonts
117.. _original proposal: https://github.com/pypa/setuptools/issues/2227#issuecomment-653628344
118.. _wheel package format: https://www.python.org/dev/peps/pep-0427/
119.. _ouroboros: https://en.wikipedia.org/wiki/Ouroboros
120