Skip to content

Commit 0d59f7d

Browse files
authored
Merge pull request #13 from wimglenn/v0.8.2
move setup guide higher to top on landing page, bump version for release
2 parents d867bd8 + 2322579 commit 0d59f7d

File tree

3 files changed

+28
-28
lines changed

3 files changed

+28
-28
lines changed

README.rst

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,30 @@ requests client side and rate-limits the get_data function, as
3030
Thanks!
3131

3232

33+
Quickstart
34+
----------
35+
36+
Install with pip
37+
38+
.. code-block:: bash
39+
40+
pip install advent-of-code-data
41+
42+
**Puzzle inputs differ by user.** So export your session ID, for example:
43+
44+
.. code-block:: bash
45+
46+
export AOC_SESSION=cafef00db01dfaceba5eba11deadbeef
47+
48+
This is a cookie which is set when you login to AoC. You can find it with
49+
your browser inspector. If you're hacking on AoC at all you probably already
50+
know these kind of tricks, but if you need help with that part then you can
51+
`look here <https://github.com/wimglenn/advent-of-code/issues/1>`_.
52+
53+
*Note:* If you don't like the env var, you could also put into a text file
54+
in your home directory (use the filename ``~/.config/aocd/token``).
55+
56+
3357
Automated submission
3458
--------------------
3559

@@ -111,32 +135,8 @@ As you can see above, I actually had incorrect code for `2017 Day 20: Particle S
111135
By the way, the ``aoc`` runner will kill your code if it takes more than 60 seconds, you can increase/decrease this by passing a command-line option, e.g. ``--timeout=120``.
112136
113137
114-
Setup Guide
115-
-----------
116-
117-
Install with pip
118-
119-
.. code-block:: bash
120-
121-
pip install advent-of-code-data
122-
123-
**Puzzle inputs differ by user.** So export your session ID, for example:
124-
125-
.. code-block:: bash
126-
127-
export AOC_SESSION=cafef00db01dfaceba5eba11deadbeef
128-
129-
This is a cookie which is set when you login to AoC. You can find it with
130-
your browser inspector. If you're hacking on AoC at all you probably already
131-
know these kind of tricks, but if you need help with that part then you can
132-
`look here <https://github.com/wimglenn/advent-of-code/issues/1>`_.
133-
134-
*Note:* If you don't like the env var, you could also put into a text file
135-
in your home directory (use the filename ``~/.config/aocd/token``).
136-
137-
138-
How does it work?
139-
-----------------
138+
How does this library work?
139+
---------------------------
140140
141141
It will automatically get today's data at import time, if used within the
142142
interactive interpreter. Otherwise, the date is found by introspection of the

aocd/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "0.8.1"
1+
__version__ = "0.8.2"

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
setup(
55
name="advent-of-code-data",
6-
version="0.8.1",
6+
version="0.8.2",
77
description="Get your puzzle data with a single import",
88
long_description=open("README.rst").read(),
99
long_description_content_type="text/x-rst",

0 commit comments

Comments
 (0)