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.

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

Documentation #42

Merged
merged 33 commits into from
Sep 22, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
0942823
Add dev packages for documentation
bpepple Sep 13, 2021
78cea83
Add __version__ to project __init__ module
bpepple Sep 13, 2021
6253762
Initial documentation
bpepple Sep 13, 2021
f32ad56
Run pre-commit
bpepple Sep 13, 2021
8b25853
Make the sphinx packages an optional install dep
bpepple Sep 13, 2021
4655cf0
Select the docstring checks
bpepple Sep 13, 2021
d92de19
Add docstrings to project __init__
bpepple Sep 13, 2021
f901648
Add config for readthedocs
bpepple Sep 13, 2021
d4321eb
Add docstring for creator & creator_list
bpepple Sep 13, 2021
ac0aca3
Add docstring for issue & issue_list
bpepple Sep 14, 2021
1549f79
Add docstring for publisher & publisher_list
bpepple Sep 14, 2021
e85ced9
Add basic docstring to docs conf
bpepple Sep 14, 2021
4c586c2
Initial docstrings for session module
bpepple Sep 14, 2021
72ea002
Add docstring for story_arc & story_arc_list
bpepple Sep 14, 2021
567c3dd
Add docstring for sqlite_cache
bpepple Sep 14, 2021
1a74eaf
Add docstring for volume & volume_list
bpepple Sep 14, 2021
2c89dfd
Fix return type for story_arc_list method
bpepple Sep 14, 2021
e7f6457
Add docstring for exceptions
bpepple Sep 14, 2021
cb30f66
Add docstring for generic_entries
bpepple Sep 14, 2021
5a6016b
Add some basic docstring to test configs
bpepple Sep 14, 2021
d8549ae
Add docstring to the creator tests
bpepple Sep 14, 2021
2c0aa40
Add missing newline
bpepple Sep 14, 2021
99cac3a
Add blank line to docstring to quite flake8
bpepple Sep 14, 2021
932b558
Add docstring to test_init
bpepple Sep 14, 2021
3eb7b37
Add docstring for test_issues
bpepple Sep 14, 2021
d75475f
Add docstring for test_publishers
bpepple Sep 14, 2021
1bc6fe8
Add dosctrings for test_volumes
bpepple Sep 14, 2021
65ec984
Add docstring for test_story_arcs
bpepple Sep 14, 2021
43f5270
Add additional flake8 deps to pre-commit
bpepple Sep 14, 2021
47717d7
Add missing newline
bpepple Sep 14, 2021
a77b48b
Fix some copy paste errors
bpepple Sep 14, 2021
966a9bd
Update tests/test_issues.py
bpepple Sep 14, 2021
5cc7284
Merge branch 'main' into documentation
bpepple Sep 22, 2021
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
Prev Previous commit
Next Next commit
Add some basic docstring to test configs
  • Loading branch information
bpepple committed Sep 14, 2021
commit 5a6016b3e20e493bf611ac978681276cbcf8ff5c
1 change: 1 addition & 0 deletions tests/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"""Tests for Simyan."""
6 changes: 6 additions & 0 deletions tests/conftest.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
Conftest module.
This module contains pytest fixtures.
"""
import os

import pytest
Expand All @@ -7,9 +11,11 @@

@pytest.fixture(scope="session")
def comicvine_api_key():
"""Comic Vine api key fixture."""
return os.getenv("COMICVINE_API_KEY", "INVALID")


@pytest.fixture(scope="session")
def comicvine(comicvine_api_key):
"""Simyan api fixture."""
return api(api_key=comicvine_api_key, cache=sqlite_cache.SqliteCache("tests/Simyan-Cache.sqlite", expiry=None))