Welcome to Django Fiction Outlines’s documentation!¶

Contents:

Introduction¶

Welcome to Django Fiction Outlines!

Being a reusable Django app for managing fiction outlines. Part of the broader maceoutliner project.

Documentation¶

The full documentation is at https://django-fiction-outlines.readthedocs.io.

Code Repo and Issue Tracker¶

The code repository and issue list for this project can be found at Github.

License¶

BSD License for your convenience.

Features¶

Provides models for managing series, outlines, characters, locations, and arcs.
Provides tools for managing multiple arcs within the context of a broader story outline.
Validates that arcs and outlines follow principles of MACE nesting, and seven point story structure.
Calculates estimated length of final manuscript based on complexity of outline.
Objects are associated with users to enable permission management.
Export outlines to OPML, JSON, or Markdown documents.
- NOTE: Django Fiction Outlines uses an object permission manager called django-rules. This allows extremely flexible permission schemes without crufting up your database or model logic. By default, fiction_outlines will restrict any view or editing to the owner of the object.

What It Doesn’t Do¶

Provide a full UI for managing the changes. An API and views are provided, but templates are very basic. It is expected that you will override the templates to match your overall project.
Outline the whole story for you.
Write the story for you.
Do your laundry.

Running Tests¶

Does the code actually work?

$ pip install -r test_requirements.txt
$ pytest
$ pytest --flake8

Credits¶

Tools used in rendering this package:

Installation¶

At the command line:

$ easy_install django-fiction-outlines

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv django-fiction-outlines
$ pip install django-fiction-outlines

Quickstart¶

Install Django Fiction Outlines:

pip install django-fiction-outlines

Add it and dependencies to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'taggit',
    'rules.apps.AutodiscoverRulesConfig',
    'fiction_outlines',
    ...
)

Add rules to your AUTHENTICATION_BACKENDS:

AUTHENTICATION_BACKENDS = (
    'rules.permissions.ObjectPermissionBackend',
    'django.contrib.auth.backends.ModelBackend',
)

Unless you like to live dangerously, it is STRONGLY recommend you configure whichever database you use for outlines to have ATOMIC_REQUESTS to True.

DATABASES = {
    "default": {
        "ENGINE": "django.db.backends.postgresql",
        "NAME": "outlines",
        "ATOMIC_REQUESTS": True,
    }}

Add Django Fiction Outlines’s URL patterns:

from fiction_outlines import urls as fiction_outlines_urls


urlpatterns = [
    ...
    url(r'^', include(fiction_outlines_urls)),
    ...
]

Tutorial¶

When working with Django fiction outlines, it is important to understand that it is an opinionated library, and leans heavily on three concepts.

Concepts¶

M.A.C.E. Quotient¶

The principle that each story thread (or arc) is one of four primary types.

Milieu: About the journey through a place.
Answers: A question or mystery that must be answered.
Character: The journey and change within a character for better or worse.
Event: An external event that must be dealt with.

This is author Mary Robinette Kowal’s [1] version of Orson Scott Card’s orgiinal M.I.C.E. quotient, and I think her version is easier to follow.

[1]	This project is neither associated with, nor endorsed by, Mary Robinette Kowal or Orson Scott Card.

Nesting¶

Again, from Kowal, that story threads, regardless of MACE type, should be resolved in the opposite order in which they were introduced. Last in, first out. [2]

[2]	Savvy watchers of this lecture will note that `fiction_outlines` also draws its formula for estimating overall manuscript length from Kowal as well.

Seven Point Story Structure¶

This one comes from author Dan Wells, [3] whose talk on story structure has helped countless writers out there. Essentially, a well-crafted arc consists of seven milestones:

Hook: the starting state.
Plot Turn 1: What changes that starts this part of the story?
Pinch 1: The first major road block faced along the path.
Midpoint: The halfway mark.
Pinch 2: The great challenge. All seems lost.
Plot Turn 2: What change or realization occurs to make the resolution possible.
Resolution: Completion of the arc. Should be the opposite state of the hook.

Try/Fail cycles should be inserted in-between milestones to direct the pacing and ensure the story earns its milestone moments.

[3]	This project is neither associated with, nor endorsed by, Dan Wells.

Intro to `fiction_outlines` Models¶

First Tier Models¶

There are four elements in fiction_outlines from which everything else descends. Those are:

Outline: The actual outline container object.
Series: A collection of related outlines and other objects.
Character: A single character which can in turn be used in multiple series and outlines.
Location: Settings/locations which can in turn be used in multiple series and outlines.

The purpose of each should be relatively clear.

Second Tier Models¶

CharacterInstance: A related record for a character with an individual outline. Contains additional metadata as to the character’s role in the outline.
LocationInstance: Same as a CharacterInstance, but for Location.
StoryElementNode: This model makes up the actual outline elements for the story. It descends from the outline, and represents the structure of the story using a materialized path tree.
Arc: A story arc, associated with a single MACE type. An outline can have 1 to n arcs. For example, a short story may only have one arc, but a novel will have many. An arc is expected to conform to seven point story structure, and its default state will consist of those milestones.

ArcElementNode: This model represents the nodes of the materialized path tree describing all the points of the arc. One of more character or location instances may be associated with each node. In turn, an arc element node can be associated with a StoryElementNode allowing the outliner to visualize the overall story structure of the entire outline.

Usage¶

Let’s say you want to represent a user who is outlining a new series. We’ll call them user1.

series = Series(
             title='My new franchise',
             description='This is gonna be the next Harry Potter, I just know it.',
             tags='urban fantasy, high hopes',
             user=user1
)
series.save()
my_outline = Outline(
             title='It begins',
             description='A twenty-something discovers that they are the chosen one to defend the city against all harm.',
             tags='heroine, fae',
             user=user1
)
my_outline.save()
# You now have the series and outline, and can proceed to add arcs or start working at the overall plot level.
main_arc = my_outline.create_arc(name='Chosen One', mace_type='character', description='Coming into her own')
# The above command, creates the arc instance and also generates the initial skeleton of the arc using seven
# point story structure.

# Let's add a character.
samantha = Character(
             name='Samantha Cowler',
             description='A cyncial and disaffected young woman destined to be a hero',
             tags='heroine',
             user=user1
)
samantha.save()
samantha_first_book = CharacterInstance(character=samantha, outline=my_outline, pov_character=True, protagonist=True, main_character=True)
samantha_first_book.save()
# Add a location
sam_job = Location(name='The Damn Bar', description='The tavern where Samantha works.', tags='human, normality', user=user1)
sam_job.save()
sam_job_first_book = LocationInstance(location=sam_job, outline=my_outline)
sam_job_first_book.save()
# Want to fetch the arc or story structure?
arc_tree = arc.arc_root_node.get_descendants()
story_tree = my_outline.story_tree_root.get_descendants()

For more detail on how to work with these objects, please review the apiref.

NOTE: It is almost always better to use fiction_outlines’ provided views as opposed to manually manipulating the models. The views make working with the objects less complex, and also provide an object-level security model. If you must work with them directly, it is recommended that you subclass the view itself and make your modifications there.

API¶

Models¶

There are two types of models used in Fiction Outlines, Standard and Tree.

Standard¶

Standard models are rather typical Django models and so the API is much as you would expect.

class fiction_outlines.models.Series(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

Container object to hold multiple outline objects if necessary.

Parameters:	created (AutoCreatedField) – Created modified (AutoLastModifiedField) – Modified id (UUIDField) – Id title (CharField) – Name of the series. You can always change this later. description (TextField) – Jot down a description about your series. user_id (ForeignKey) – The user that created this Series.

This model represents a story series that can hold one or more outlines within it. it is not necessary to define a Series, but it is a useful organizational tool. Standard Django ORM applies.

class fiction_outlines.models.Character(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

Reusable character defintion model.

Parameters:	created (AutoCreatedField) – Created modified (AutoLastModifiedField) – Modified id (UUIDField) – Id name (CharField) – Name of the character. description (TextField) – Notes about the character to help you remember. user_id (ForeignKey) – The user that created this character.

This model represents a character that may be reused in multiple series, outlines, and story elements.

class fiction_outlines.models.CharacterInstance(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

An instance of the character object that can be associated with outlines.

Parameters:

created (AutoCreatedField) – Created
modified (AutoLastModifiedField) – Modified
id (UUIDField) – Id
main_character (BooleanField) – Is this character the main character for the outline?
pov_character (BooleanField) – Is this character a POV character?
protagonist (BooleanField) – Does this character serve as the protagonist for this outline?
antagonist (BooleanField) – Does this character serve as an antagonist for this outline?
obstacle (BooleanField) – Is this character an obstacle in the outline? (not antagonist)
villain (BooleanField) – Is the character a straight-out villain?
character_id (ForeignKey) – Reference to originating character object.
outline_id (ForeignKey) – Outline this instance is associated with.

This model represents a single instance of a character that is associated with an Outline. Contains additional metadata on the character’s role in the story.

class fiction_outlines.models.Location(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

Reusable location definition model

Parameters:	created (AutoCreatedField) – Created modified (AutoLastModifiedField) – Modified id (UUIDField) – Id name (CharField) – Name of the location. description (TextField) – Notes about the location to help you remember. user_id (ForeignKey) – The user that created this location.

This model represents a location that may be reused in multiple series, outlines, and story elements.

class fiction_outlines.models.LocationInstance(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

An instance of the given location that can be associated with a given outline.

Parameters:	created (AutoCreatedField) – Created modified (AutoLastModifiedField) – Modified id (UUIDField) – Id location_id (ForeignKey) – Originating location object. outline_id (ForeignKey) – Outline this object is associated with.

This model represents an instance of a location that is associated with an outline.

class fiction_outlines.models.Outline(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

The typical top of the hierarchy when not enclosed in a series.

Parameters:

created (AutoCreatedField) – Created
modified (AutoLastModifiedField) – Modified
id (UUIDField) – Id
title (CharField) – Outline title. You can always change this later.
description (TextField) – Optionally, describe the story. Or use for notes.
series_id (ForeignKey) – Belongs to series.
user_id (ForeignKey) – The user that created this outline.

The outline is the manuscript level element that represents and encapsulates all the information about a specific work. It provides a number of convenient convenience features.

Outline.length_estimate()¶

Calculates and estimated word count based on number of characters, locations, and arcs. For reference see: http://www.writingexcuses.com/2017/07/02/12-27-choosing-a-length/

This is a cached property that calculates the projected total length of the manuscript.

Example:

o1.length_estimate
# Returns estimated total words.

Outline.story_tree_root()¶

Fetches the root node for the outline’s StoryElementNode tree.

Cached property that returns the root of the outline tree.

Example:

root_node = o1.story_tree_root

Outline.refresh_from_db(*args, **kwargs)[source]¶

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

Just like Django’s refresh_from_db() except that this clears the property cache of the object as well.

Outline.create_arc(mace_type, name)[source]¶

Creates the story arc and initial tree for that arc for the current outline. Returns the resulting Arc instance.

Creates an Arc object within the outline, and builds the initial tree of ArcElementNode objects. Returns the Arc object.

Example:

arc1 = o1.create_arc(mace_type='event', name='Dragon Invasion')

Outline.validate_nesting()[source]¶

Reviews the story tree and validates associated arc elements are nested appropriately. Returns a dict of errors.

Evaluates the tree of StoryElementNode objects and returns a dict of errors if any are found. For each error entry, a list of offending nodes will also be included.

Example:

error_dict = o1.validate_nesting()
if error_dict:
   # There are errors
   for key, value in error_dict.items():
       print("%s: %s" % (key, value)

class fiction_outlines.models.Arc(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

A MACE arc for a outline.

Parameters:	created (AutoCreatedField) – Created modified (AutoLastModifiedField) – Modified id (UUIDField) – Id mace_type (CharField) – The MACE type of the Arc. outline_id (ForeignKey) – Arc belongs to this outline. name (CharField) – Name of this Arc (makes it easier for you to keep track of it.)

The arc represents a story throughline that will be integrated with the outline.

Arc.current_errors()¶

Returns list of errors from arc_validation.

A cached property of current structural errors within the Arc.

Arc.arc_root_node()¶

Returns the root node from this object’s ArcElementNode tree.

A cached property pointing to the root node of the ArcElementNode object tree.

Arc.refresh_from_db(*args, **kwargs)[source]¶

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

Like the standard Django method, but this also clears cached properties.

Arc.generate_template_arc_tree()[source]¶

Generate a seven point template in this arc. Arc must be empty.

Creates the template arc tree using Seven Point Story Structure.

Arc.fetch_arc_errors()[source]¶

Evaluates the current tree of the arc and provides a list of errors that the user should correct.

Evaluates the arc tree for errors the user is recommended to correct.

Arc.validate_first_element()[source]¶

Ensures that the first node for the direct decendents of root is the hook.

Checks that the first child of the root is the Hook.

Arc.validate_last_element()[source]¶

Ensures that the last element of the arc is the resolution.

Checks that the last child of the root is the Resolution.

Arc.validate_generations()[source]¶

Make sure that the descendent depth is valid.

Reviews the structure of the Arc to ensure that node types follow the allowed_parents and allowed_children properties.

Arc.validate_milestones()[source]¶

Reviews the arc element tree to ensure that milestones appear in the right order.

Verifies that milestones appear in the tree in the Arc tree in the correct sequence.

Tree Models¶

Tree models are Materialized Path trees descended from the django-treebeard provided MP_Node.

Note

A discussion of the details of working with MP trees is out of scope for this document. You are recommended to peruse django-treebeard’s excellent documentation. Make sure to also review fiction_outlines Caveats documentation.

class fiction_outlines.models.ArcElementNode(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel, treebeard.mp_tree.MP_Node

Tree nodes for the arc elements.

Parameters:

created (AutoCreatedField) – Created
path (CharField) – Path
depth (PositiveIntegerField) – Depth
numchild (PositiveIntegerField) – Numchild
modified (AutoLastModifiedField) – Modified
id (UUIDField) – Id
arc_element_type (CharField) – What part of the arc does this represent?
arc_id (ForeignKey) – Parent arc.
headline (CharField) – Autogenerated from description
description (TextField) – Describe what happens at this moment in the story…
story_element_node_id (ForeignKey) – Which story node is this element associated with?

This model represents the nodes of the tree that is used as the structure of the Arc.

ArcElementNode.milestone_seq()¶

Returns the milestone sequence based off of the arc element definitions.

Cached property retrieving the derived milestone sequence number as it relates to 7PSS_.

ArcElementNode.is_milestone()¶

Does this node represent an arc milestone?

Cached property returning if this node represents an arc milestone.

ArcElementNode.parent_outline()¶

Private method to fetch parent outline.

Cached property for convenient access to the outline to which this arc tree belongs.

ArcElementNode.move(target, pos=None)¶

Moves the current node and all it’s descendants to a new position relative to another node.

Raises:	PathOverflow – when the library can’t make room for the node’s new position

Subclass of the treebeard method. Fires a tree_manipulation signal for your use.

ArcElementNode.add_child(arc_element_type, description=None, story_element_node=None, **kwargs)[source]¶

Overrides the default treebeard function, adding additional integrity checks.

Subclasses the treebeard method to add required logic for instantiating an Arc Element object.

Example:

# Add a try/fail cycle
new_element = ae1.add_child('tf', description="Attempting to get into the secret enclave to get information")

ArcElementNode.add_sibling(pos=None, arc_element_type=None, description=None, story_element_node=None, **kwargs)[source]¶

Overrides the default treebeard function, adding additional integrity checks.

Subclasses the treebeard method to add specific model instantiation requirements.

Example:

# Add another beat that followed after another one
beat2 = beat1.add_sibling('beat', description="John discovers an odd item in his bag.")

class fiction_outlines.models.StoryElementNode(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel, treebeard.mp_tree.MP_Node

Tree nodes for the overall outline of the story.

Parameters:

created (AutoCreatedField) – Created
path (CharField) – Path
depth (PositiveIntegerField) – Depth
numchild (PositiveIntegerField) – Numchild
modified (AutoLastModifiedField) – Modified
id (UUIDField) – Id
name (CharField) – Optional name/title for this element of the story.
description (TextField) – Optional description for this element of the story.
outline_id (ForeignKey) – Parent outline.
story_element_type (CharField) – What part of the story does this represent? A scene? A chapter?

This class represent the actual structure of the overall outline. Individual arc elements can be associated with a story node, which is how the outline validation tool can verify that Nesting is valid.

StoryElementNode.all_characters()¶

Returns a queryset of all characters associated with this node and its descendants, excluding any duplicates.

A property that returns queryset of all the unique character instances associated with this node, and any of its descendant nodes.

StoryElementNode.all_locations()¶

Returns a queryset of all locations associated with this node and its descendants, excluding any duplicates.

A property that returns a queryset of all the unique location instances associated with this node, and any of its descendant nodes.

StoryElementNode.impact_rating()¶

Returns the impact rating for this node. Impact rating is a measure of how powerful this moment in the story is by evaluting how many simultaneous arc elements are associated with it. There is also a generational bleed element, where the impact score creates shockwaves throughout their direct ancestor and descendant nodes. This echo fades fast, but the bigger the impact, the farther it goes.

Currently, the impact bleed does not extend to sibling nodes.

WARNING: Here be dragons.

A property representing the impact/tension rating of this node (expressed as a float) in the outline. This rating is derived from associations with arc elements, with extra impact when mulitple arcs overlap in the same node. Impact also affects ancestor and descendant nodes with weakening influence the more generations away from the source node. However, impact bleed does not extend to sibling nodes.

StoryElementNode.move(target, pos=None)[source]¶

An override of the treebeard api in order to send a signal in advance.

Subclass of the treebeard move method, but also sends signal tree_manipulation which you can use with your signal receivers.

StoryElementNode.add_child(story_element_type=None, outline=None, name=None, description=None, **kwargs)[source]¶

An override of the treebeard add_child() method so we can send a signal.

Subclass of the treebeard method, but adds instantiation logic for this model.

Example:

new_node = node.add_child(story_element_type='chapter', outline=o1, name='Chapter 1', description='Our story begins.')

StoryElementNode.add_sibling(story_element_type=None, outline=None, name=None, description=None, pos=None, **kwargs)[source]¶

Override of treebeard api to allow us to send a signal.

Subclass of the treebeard method, but adds model instantiation logic.

Example:

chap2 = new_node.add_sibling(story_element_type='chapter', outline=o1, name='Chapter 2', description='Meanwhile, on the other side of the world')

Caveats¶

Be aware that as tree models are descendents of the django-treebeard MP_Node class, the same Known Caveats apply.

Warning

Do NOT attempt to create a new node using the Django-provided construction method. Use dedicated methods such as add_root, add_child, and add_sibling instead.
Do NOT attempt to directly edit path, step, depth, num_child, etc. Use the provided move method.
MP_Node uses a lot of raw SQL, so always retrieve the node from the db again after tree manipulation before calling it to do anything else.
Object permissions come from django-rules, and the permission logic lies in the view layer. If you want to introduce your own custom logic, you should subclass the provided views in order to reduce the risk of security breaches.
For the same reason, if you must define a custom manager, you NEED to subclass treebeard’s base MP_Node manager.

Signals¶

tree_manipulation¶

Fires off a signal on tree manipulation, e.g. a move() method. Sends the following:

Variable Description Allowed values

action What tree manipulation method was called?
add_child

add_sibling

move

update

target_node_type Class of the target node.
If a StoryElementNode, this will be the value of story_element_type.

If an ArcElementNode, it will be the value of arc_element_type.

target_node The node to which this is being move in relation to. If this is a move action, this will be populated with the target node for the move.

pos Position relative to the target_node that this cell should be added to. Only populated when action is equal to move.
left

right

first-child

last-child

first-sibling

last-sibling

Receivers¶

The following functions are currently tied to the signals generated in fiction_outlines. See Signals for additional information.

receivers.generate_headline_from_description(instance, *args, **kwargs)¶: Auto generate the headline of the node from the first lines of the description.

receivers.story_root_for_new_outline(instance, created, *args, **kwargs)¶: If a new instance of a Outline is created, also create the root node of the story tree.

receivers.arc_node_edit_add_missing_characters_and_locations_to_related_story_node(instance, action, reverse, pk_set, *args, **kwargs)¶: If an arc_element is modified and it’s characters/locations are not already in the story node, add them. We don’t assume that removing the arc element would change the characters or locations as of yet. This takes up a little more space in the database, but the additional flexibility for users is worth it.

receivers.story_node_add_arc_element_update_characters_locations(instance, created, *args, **kwargs)¶: If an arc element is added to a story element node, add any missing elements or locations.

receivers.validate_arc_links_same_outline(instance, *args, **kwargs)¶: Evaluates attempts to link an arc to a story node from another outline.

receivers.validate_character_instance_valid_for_arc(instance, action, reverse, pk_set, *args, **kwargs)¶: Evaluate attempts to assign a character instance to ensure it is from same outline.

receivers.validate_location_instance_valid_for_arc(instance, action, reverse, pk_set, *args, **kwargs)¶: Evaluates attempts to add location instances to arc, ensuring they are from same outline.

receivers.validate_character_for_story_element(instance, action, reverse, pk_set, *args, **kwargs)¶: Validates that character is from the same outline as the story node.

receivers.validate_location_for_story_element(instance, action, reverse, pk_set, *args, **kwargs)¶: Validates that location is from same outline as story node.

receivers.validate_generations_for_story_elements(instance, action, target_node_type=None, target_node=None, pos=None, *args, **kwargs)¶: Unlike arc nodes, for which we just warn about structure, the story tree allowed parent/child rules must be strictly enforced.

Views¶

Views are provided for the majority of common tasks when working with fiction_outlines. Once again, these views are where the object permission model is enforced, so always subclass rather than just replace them.

For the most part, these operate as generic views and all the same functionality applies.

Note

Basic templates for all of these views are provided, but it is expected that you will override them with your own as needed.

class fiction_outlines.views.SeriesListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.list.ListView

Generic view for viewing a list of series objects.

class fiction_outlines.views.SeriesDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view to see series details.

class fiction_outlines.views.SeriesUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.UpdateView

Generic view for updating a series object.

class fiction_outlines.views.SeriesCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating series object.

class fiction_outlines.views.SeriesDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.DeleteView

Generic view for deleting a series.

class fiction_outlines.views.CharacterListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.list.ListView

Generic view for viewing character list.

class fiction_outlines.views.CharacterDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for character details.

class fiction_outlines.views.CharacterUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.UpdateView

Generic update view for character.

class fiction_outlines.views.CharacterCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating a character.

class fiction_outlines.views.CharacterDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

Generic view for deleting a character.

class fiction_outlines.views.CharacterInstanceListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.list.ListView

Generic view for seeing a list of all character instances for a particular character.

class fiction_outlines.views.CharacterInstanceDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic detail view for character instance.

class fiction_outlines.views.CharacterInstanceUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, django.views.generic.edit.UpdateView

Generic view for updating a character instance.

class fiction_outlines.views.CharacterInstanceCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Generic create view for a character instance.

class fiction_outlines.views.CharacterInstanceDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

Generic view for deleting character instances.

class fiction_outlines.views.LocationListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.list.ListView

Generic view for locations.

class fiction_outlines.views.LocationDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for location details.

class fiction_outlines.views.LocationUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.UpdateView

Generic view for updating locations.

class fiction_outlines.views.LocationCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating locations

class fiction_outlines.views.LocationDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.DeleteView

Generic view for deleting locations.

class fiction_outlines.views.LocationInstanceListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.list.ListView

Generic view for looking at all location instances for a location.

class fiction_outlines.views.LocationInstanceDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for a location instance detail view.

class fiction_outlines.views.LocationInstanceUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, django.views.generic.edit.UpdateView

Generic view for updating a location instance. Not used since there are not details. But it’s here if you want to subclass LocationInstance and customize it.

class fiction_outlines.views.LocationInstanceCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating a location instance on a outline.

class fiction_outlines.views.LocationInstanceDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

Generic delete view for Location Instance.

class fiction_outlines.views.OutlineListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.list.ListView

Generic view for Outline Outline list

class fiction_outlines.views.OutlineDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for Outline detail

class fiction_outlines.views.OutlineExport(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view to get an export of an outline record.

Takes a url kwarg of outline as the pk of the fiction_outlines.models.Outline The url kwarg of format determines the type returned. Current supported formats are opml, json, or md.

A view that can return a dowloadable export of an outline with structure preserved. Formats supported: OPML, JSON, Markdown For fullest fidelity of data, JSON is the best choice. OPML and Markdown necessarily force the application to strip out quite a bit of nested data.

class fiction_outlines.views.OutlineUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.UpdateView

Generic update view for outline details.

class fiction_outlines.views.OutlineCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating initial outline.

class fiction_outlines.views.OutlineDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.DeleteView

Generic delete view for an outline.

class fiction_outlines.views.ArcListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.list.ListView

Generic list view for arcs in a outline

class fiction_outlines.views.ArcDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for arc details.

class fiction_outlines.views.ArcUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, django.views.generic.edit.UpdateView

Generic view for updating arc details

class fiction_outlines.views.ArcCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating an arc.

class fiction_outlines.views.ArcDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.DeleteView

Generic view for deleting an arc

class fiction_outlines.views.ArcNodeDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

View for looking at the details of an atomic node as opposed to the whole tree.

class fiction_outlines.views.ArcNodeUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.UpdateView

View for editing details of an arc node (but not it’s tree position).

class fiction_outlines.views.ArcNodeCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Create view for an arc node. Assumes that the target position has already been passed to it via kwargs.

class fiction_outlines.views.ArcNodeDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

View for deleting an arc node.

Incorporates logic to ensure that if the node represents the Hook or Resolution of the Seven Point Story Structure, it cannot be deleted.

class fiction_outlines.views.ArcNodeMoveView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.UpdateView

View for executing a move method on an arcnode.

class fiction_outlines.views.StoryNodeCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Creation view for a story node. Assumes the target and pos have been passed as kwargs.

class fiction_outlines.views.StoryNodeMoveView(**kwargs)[source]¶

Bases: fiction_outlines.views.StoryNodeUpdateView

View for executing a move method on an arcnode.

class fiction_outlines.views.StoryNodeDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

View for looking at the details of an atomic story node as opposed to the whole tree.

class fiction_outlines.views.StoryNodeUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.UpdateView

View for doing basic updates to a story node, but not regarding its position in the tree.

Will add additional form errors if it is attempted to edit the story_element_type in a manner which would break the structure of the outline.

class fiction_outlines.views.StoryNodeCreateView(**kwargs)[source]

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Creation view for a story node. Assumes the target and pos have been passed as kwargs.

class fiction_outlines.views.StoryNodeDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

Genric view for deleting a story node.

Forms¶

Model forms are provided for convenience and can be fed specific kwargs in order to ensure that users are not presented with choices that should not be permitted.

class fiction_outlines.forms.CharacterInstanceForm(*args, **kwargs)[source]¶

Bases: django.forms.models.ModelForm

Form for creating character instances

Takes an additional kwarg of character which should represent a Character instance.

class fiction_outlines.forms.LocationInstanceForm(*args, **kwargs)[source]¶

Bases: django.forms.models.ModelForm

Form for creating location instances.

Takes an additional kwarg of location which should represent an instance of Location.

class fiction_outlines.forms.CharacterForm(*args, **kwargs)[source]¶

Bases: django.forms.models.ModelForm

Form for Character model.

Takes an additional kwarg of user which should represent an instance of AUTH_USER_MODEL.

class fiction_outlines.forms.LocationForm(*args, **kwargs)[source]¶

Bases: django.forms.models.ModelForm

Form class for Locations

Takes an additional kwarg of user which should represent an instance of AUTH_USER_MODEL.

class fiction_outlines.forms.OutlineForm(*args, **kwargs)[source]¶

Bases: django.forms.models.ModelForm

Form class for Outline model

Takes an additional kwarg of user which should represent an instance of AUTH_USER_MODEL.

class fiction_outlines.forms.OutlineMoveNodeForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=':', empty_permitted=False, instance=None, **kwargs)[source]¶

Bases: treebeard.forms.MoveNodeForm

Subclass of base treebeard move node form allowing us to restrict target node options to within a single tree.

It is recommended that you do not subclass or directly call this form, but instead use treebeard.forms.movenodeform_factory.

Example:

from treebeard.forms import movenodeform_factory
from fiction_outlines import forms
from fiction_outlines.views import ArcNodeMoveView

class SomeFormOrModelView(ArcNodeMoveView):

    model = ArcElementNode  # As an example
    form_class = movenodeform_factory(ArcElementNode, form=forms.OutlineMoveNodeForm, ...)
    ...

fiction_outlines¶

fiction_outlines package¶

Submodules¶

fiction_outlines.admin module¶

fiction_outlines.apps module¶

class fiction_outlines.apps.FictionOutlinesConfig(app_name, app_module)[source]¶

Bases: django.apps.config.AppConfig

name = 'fiction_outlines'¶

ready()[source]¶: Override this method in subclasses to run code when Django starts.

verbose_name = 'Fiction Outlines'¶

fiction_outlines.models module¶

class fiction_outlines.models.Arc(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

A MACE arc for a outline.

Parameters:	created (AutoCreatedField) – Created modified (AutoLastModifiedField) – Modified id (UUIDField) – Id mace_type (CharField) – The MACE type of the Arc. outline_id (ForeignKey) – Arc belongs to this outline. name (CharField) – Name of this Arc (makes it easier for you to keep track of it.)

exception DoesNotExist¶: Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: django.core.exceptions.MultipleObjectsReturned

arc_root_node¶: Returns the root node from this object’s ArcElementNode tree.

arcelementnode_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

current_errors¶: Returns list of errors from arc_validation.

fetch_arc_errors()[source]¶: Evaluates the current tree of the arc and provides a list of errors that the user should correct.

generate_template_arc_tree()[source]¶: Generate a seven point template in this arc. Arc must be empty.

get_absolute_url()[source]¶

get_mace_type_display(*, field=<django.db.models.fields.CharField: mace_type>)¶

get_next_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=True, **kwargs)¶

get_next_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=True, **kwargs)¶

get_previous_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=False, **kwargs)¶

get_previous_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=False, **kwargs)¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

mace_type¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

outline¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

outline_id¶

refresh_from_db(*args, **kwargs)[source]¶

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

validate_first_element()[source]¶: Ensures that the first node for the direct decendents of root is the hook.

validate_generations()[source]¶: Make sure that the descendent depth is valid.

validate_last_element()[source]¶: Ensures that the last element of the arc is the resolution.

validate_milestones()[source]¶: Reviews the arc element tree to ensure that milestones appear in the right order.

class fiction_outlines.models.ArcElementNode(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel, treebeard.mp_tree.MP_Node

Tree nodes for the arc elements.

Parameters:

created (AutoCreatedField) – Created
path (CharField) – Path
depth (PositiveIntegerField) – Depth
numchild (PositiveIntegerField) – Numchild
modified (AutoLastModifiedField) – Modified
id (UUIDField) – Id
arc_element_type (CharField) – What part of the arc does this represent?
arc_id (ForeignKey) – Parent arc.
headline (CharField) – Autogenerated from description
description (TextField) – Describe what happens at this moment in the story…
story_element_node_id (ForeignKey) – Which story node is this element associated with?

exception DoesNotExist¶: Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: django.core.exceptions.MultipleObjectsReturned

add_child(arc_element_type, description=None, story_element_node=None, **kwargs)[source]¶: Overrides the default treebeard function, adding additional integrity checks.

add_sibling(pos=None, arc_element_type=None, description=None, story_element_node=None, **kwargs)[source]¶: Overrides the default treebeard function, adding additional integrity checks.

arc¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

arc_element_type¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

arc_id¶

assoc_characters¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

assoc_locations¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

description¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_absolute_url()[source]¶

get_arc_element_type_display(*, field=<django.db.models.fields.CharField: arc_element_type>)¶

get_next_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=True, **kwargs)¶

get_next_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=True, **kwargs)¶

get_previous_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=False, **kwargs)¶

get_previous_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=False, **kwargs)¶

headline¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_milestone¶: Does this node represent an arc milestone?

milestone_seq¶: Returns the milestone sequence based off of the arc element definitions.

parent_outline¶: Private method to fetch parent outline.

steplen = 5¶

story_element_node¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

story_element_node_id¶

exception fiction_outlines.models.ArcGenerationError[source]¶

Bases: fiction_outlines.models.ArcIntegrityError

Exception for when a non-milestone node is placed at an invalid level of descendency.

exception fiction_outlines.models.ArcIntegrityError[source]¶

Bases: django.db.utils.IntegrityError

Generic exception for Arc structural warnings.

class fiction_outlines.models.AutoLastModifiedField(*args, **kwargs)[source]¶

Bases: model_utils.fields.AutoLastModifiedField

Override of the default model_utils behavior to ensure that when an instance is created that the modifed and created will be the same.

pre_save(model_instance, add)[source]¶: Return field’s value just before saving.

class fiction_outlines.models.Character(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

Reusable character defintion model.

Parameters:	created (AutoCreatedField) – Created modified (AutoLastModifiedField) – Modified id (UUIDField) – Id name (CharField) – Name of the character. description (TextField) – Notes about the character to help you remember. user_id (ForeignKey) – The user that created this character.

exception DoesNotExist¶: Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: django.core.exceptions.MultipleObjectsReturned

characterinstance_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

description¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_absolute_url()[source]¶

get_next_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=True, **kwargs)¶

get_next_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=True, **kwargs)¶

get_previous_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=False, **kwargs)¶

get_previous_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=False, **kwargs)¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

series¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

tagged_items¶

Accessor to the related objects manager on the one-to-many relation created by GenericRelation.

In the example:

class Post(Model):
    comments = GenericRelation(Comment)

post.comments is a ReverseGenericManyToOneDescriptor instance.

tags = <taggit.managers._TaggableManager object>¶

user¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

user_id¶

class fiction_outlines.models.CharacterInstance(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

An instance of the character object that can be associated with outlines.

Parameters:

created (AutoCreatedField) – Created
modified (AutoLastModifiedField) – Modified
id (UUIDField) – Id
main_character (BooleanField) – Is this character the main character for the outline?
pov_character (BooleanField) – Is this character a POV character?
protagonist (BooleanField) – Does this character serve as the protagonist for this outline?
antagonist (BooleanField) – Does this character serve as an antagonist for this outline?
obstacle (BooleanField) – Is this character an obstacle in the outline? (not antagonist)
villain (BooleanField) – Is the character a straight-out villain?
character_id (ForeignKey) – Reference to originating character object.
outline_id (ForeignKey) – Outline this instance is associated with.

exception DoesNotExist¶: Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: django.core.exceptions.MultipleObjectsReturned

antagonist¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

arcelementnode_set¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

character¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

character_id¶

get_absolute_url()[source]¶

get_next_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=True, **kwargs)¶

get_next_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=True, **kwargs)¶

get_previous_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=False, **kwargs)¶

get_previous_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=False, **kwargs)¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

main_character¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

obstacle¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

outline¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

outline_id¶

pov_character¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

protagonist¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

storyelementnode_set¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

villain¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

exception fiction_outlines.models.GenericArcSequenceError[source]¶

Bases: fiction_outlines.models.ArcIntegrityError

Exception for when a non-milestone element is placed in an invalid sequence.

class fiction_outlines.models.Location(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

Reusable location definition model

Parameters:	created (AutoCreatedField) – Created modified (AutoLastModifiedField) – Modified id (UUIDField) – Id name (CharField) – Name of the location. description (TextField) – Notes about the location to help you remember. user_id (ForeignKey) – The user that created this location.

exception DoesNotExist¶: Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: django.core.exceptions.MultipleObjectsReturned

description¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_absolute_url()[source]¶

get_next_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=True, **kwargs)¶

get_next_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=True, **kwargs)¶

get_previous_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=False, **kwargs)¶

get_previous_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=False, **kwargs)¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

locationinstance_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

name¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

series¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

tagged_items¶

Accessor to the related objects manager on the one-to-many relation created by GenericRelation.

In the example:

class Post(Model):
    comments = GenericRelation(Comment)

post.comments is a ReverseGenericManyToOneDescriptor instance.

tags = <taggit.managers._TaggableManager object>¶

user¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

user_id¶

class fiction_outlines.models.LocationInstance(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

An instance of the given location that can be associated with a given outline.

Parameters:	created (AutoCreatedField) – Created modified (AutoLastModifiedField) – Modified id (UUIDField) – Id location_id (ForeignKey) – Originating location object. outline_id (ForeignKey) – Outline this object is associated with.

exception DoesNotExist¶: Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: django.core.exceptions.MultipleObjectsReturned

arcelementnode_set¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

get_absolute_url()[source]¶

get_next_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=True, **kwargs)¶

get_next_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=True, **kwargs)¶

get_previous_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=False, **kwargs)¶

get_previous_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=False, **kwargs)¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

location¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

location_id¶

objects = <django.db.models.manager.Manager object>¶

outline¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

outline_id¶

storyelementnode_set¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

exception fiction_outlines.models.MilestoneDepthError[source]¶

Bases: fiction_outlines.models.ArcIntegrityError

Exception for when an attempt to make a milestone a descendent of any node besides the root node for the tree.

exception fiction_outlines.models.MilestoneSequenceError[source]¶

Bases: fiction_outlines.models.ArcIntegrityError

Exception for when milestone arc elements violate their defined sequence rules.

class fiction_outlines.models.Outline(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

The typical top of the hierarchy when not enclosed in a series.

Parameters:

created (AutoCreatedField) – Created
modified (AutoLastModifiedField) – Modified
id (UUIDField) – Id
title (CharField) – Outline title. You can always change this later.
description (TextField) – Optionally, describe the story. Or use for notes.
series_id (ForeignKey) – Belongs to series.
user_id (ForeignKey) – The user that created this outline.

exception DoesNotExist¶: Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: django.core.exceptions.MultipleObjectsReturned

arc_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

characterinstance_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

create_arc(mace_type, name)[source]¶: Creates the story arc and initial tree for that arc for the current outline. Returns the resulting Arc instance.

description¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_absolute_url()[source]¶

get_next_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=True, **kwargs)¶

get_next_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=True, **kwargs)¶

get_previous_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=False, **kwargs)¶

get_previous_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=False, **kwargs)¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

length_estimate¶: Calculates and estimated word count based on number of characters, locations, and arcs. For reference see: http://www.writingexcuses.com/2017/07/02/12-27-choosing-a-length/

locationinstance_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

objects = <django.db.models.manager.Manager object>¶

refresh_from_db(*args, **kwargs)[source]¶

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

series¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

series_id¶

story_tree_root¶: Fetches the root node for the outline’s StoryElementNode tree.

storyelementnode_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

tagged_items¶

Accessor to the related objects manager on the one-to-many relation created by GenericRelation.

In the example:

class Post(Model):
    comments = GenericRelation(Comment)

post.comments is a ReverseGenericManyToOneDescriptor instance.

tags = <taggit.managers._TaggableManager object>¶

title¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

user¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

user_id¶

validate_nesting()[source]¶: Reviews the story tree and validates associated arc elements are nested appropriately. Returns a dict of errors.

class fiction_outlines.models.Series(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel

Container object to hold multiple outline objects if necessary.

Parameters:	created (AutoCreatedField) – Created modified (AutoLastModifiedField) – Modified id (UUIDField) – Id title (CharField) – Name of the series. You can always change this later. description (TextField) – Jot down a description about your series. user_id (ForeignKey) – The user that created this Series.

exception DoesNotExist¶: Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: django.core.exceptions.MultipleObjectsReturned

character_set¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

description¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_absolute_url()[source]¶

get_next_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=True, **kwargs)¶

get_next_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=True, **kwargs)¶

get_previous_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=False, **kwargs)¶

get_previous_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=False, **kwargs)¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

location_set¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

objects = <django.db.models.manager.Manager object>¶

outline_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

tagged_items¶

Accessor to the related objects manager on the one-to-many relation created by GenericRelation.

In the example:

class Post(Model):
    comments = GenericRelation(Comment)

post.comments is a ReverseGenericManyToOneDescriptor instance.

tags = <taggit.managers._TaggableManager object>¶

title¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

user¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

user_id¶

class fiction_outlines.models.StoryElementNode(*args, **kwargs)[source]¶

Bases: fiction_outlines.models.TimeStampedModel, treebeard.mp_tree.MP_Node

Tree nodes for the overall outline of the story.

Parameters:

created (AutoCreatedField) – Created
path (CharField) – Path
depth (PositiveIntegerField) – Depth
numchild (PositiveIntegerField) – Numchild
modified (AutoLastModifiedField) – Modified
id (UUIDField) – Id
name (CharField) – Optional name/title for this element of the story.
description (TextField) – Optional description for this element of the story.
outline_id (ForeignKey) – Parent outline.
story_element_type (CharField) – What part of the story does this represent? A scene? A chapter?

exception DoesNotExist¶: Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: django.core.exceptions.MultipleObjectsReturned

add_child(story_element_type=None, outline=None, name=None, description=None, **kwargs)[source]¶: An override of the treebeard add_child() method so we can send a signal.

add_sibling(story_element_type=None, outline=None, name=None, description=None, pos=None, **kwargs)[source]¶: Override of treebeard api to allow us to send a signal.

all_characters¶: Returns a queryset of all characters associated with this node and its descendants, excluding any duplicates.

all_locations¶: Returns a queryset of all locations associated with this node and its descendants, excluding any duplicates.

arcelementnode_set¶

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

assoc_characters¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

assoc_locations¶

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

description¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_absolute_url()[source]¶

get_next_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=True, **kwargs)¶

get_next_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=True, **kwargs)¶

get_previous_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=False, **kwargs)¶

get_previous_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=False, **kwargs)¶

get_story_element_type_display(*, field=<django.db.models.fields.CharField: story_element_type>)¶

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

impact_rating¶

Returns the impact rating for this node. Impact rating is a measure of how powerful this moment in the story is by evaluting how many simultaneous arc elements are associated with it. There is also a generational bleed element, where the impact score creates shockwaves throughout their direct ancestor and descendant nodes. This echo fades fast, but the bigger the impact, the farther it goes.

Currently, the impact bleed does not extend to sibling nodes.

WARNING: Here be dragons.

move(target, pos=None)[source]¶: An override of the treebeard api in order to send a signal in advance.

name¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

outline¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

outline_id¶

steplen = 5¶

story_element_type¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class fiction_outlines.models.TimeStampedModel(*args, **kwargs)[source]¶

Bases: model_utils.models.TimeStampedModel

Override the model_utils behavior to use our new field.

Parameters:	created (AutoCreatedField) – Created modified (AutoLastModifiedField) – Modified

class Meta[source]¶

Bases: object

abstract = False¶

get_next_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=True, **kwargs)¶

get_next_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=True, **kwargs)¶

get_previous_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=False, **kwargs)¶

get_previous_by_modified(*, field=<fiction_outlines.models.AutoLastModifiedField: modified>, is_next=False, **kwargs)¶

class fiction_outlines.models.UUIDCharacterTag(*args, **kwargs)[source]¶

Bases: taggit.models.GenericUUIDTaggedItemBase, taggit.models.TaggedItemBase

Character tags with UUID primary keys

Parameters:	id (AutoField) – Id tag_id (ForeignKey) – Tag content_type_id (ForeignKey) – Content type object_id (UUIDField) – Object id

exception DoesNotExist¶: Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: django.core.exceptions.MultipleObjectsReturned

content_object¶

Provide a generic many-to-one relation through the content_type and object_id fields.

This class also doubles as an accessor to the related object (similar to ForwardManyToOneDescriptor) by adding itself as a model attribute.

content_type¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

tag¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

class fiction_outlines.models.UUIDLocationTag(*args, **kwargs)[source]¶

Bases: taggit.models.GenericUUIDTaggedItemBase, taggit.models.TaggedItemBase

Location tags with UUID primary keys

Parameters:	id (AutoField) – Id tag_id (ForeignKey) – Tag content_type_id (ForeignKey) – Content type object_id (UUIDField) – Object id

exception DoesNotExist¶: Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: django.core.exceptions.MultipleObjectsReturned

content_object¶

Provide a generic many-to-one relation through the content_type and object_id fields.

This class also doubles as an accessor to the related object (similar to ForwardManyToOneDescriptor) by adding itself as a model attribute.

content_type¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

tag¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

class fiction_outlines.models.UUIDOutlineTag(*args, **kwargs)[source]¶

Bases: taggit.models.GenericUUIDTaggedItemBase, taggit.models.TaggedItemBase

Outline tags with UUID primary keys

Parameters:	id (AutoField) – Id tag_id (ForeignKey) – Tag content_type_id (ForeignKey) – Content type object_id (UUIDField) – Object id

exception DoesNotExist¶: Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: django.core.exceptions.MultipleObjectsReturned

content_object¶

Provide a generic many-to-one relation through the content_type and object_id fields.

This class also doubles as an accessor to the related object (similar to ForwardManyToOneDescriptor) by adding itself as a model attribute.

content_type¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

id¶: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶

tag¶

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

fiction_outlines.receivers module¶

Recieving methods for signals go here.

fiction_outlines.receivers.arc_node_edit_add_missing_characters_and_locations_to_related_story_node(sender, instance, action, reverse, pk_set, *args, **kwargs)[source]¶: If an arc_element is modified and it’s characters/locations are not already in the story node, add them. We don’t assume that removing the arc element would change the characters or locations as of yet. This takes up a little more space in the database, but the additional flexibility for users is worth it.

fiction_outlines.receivers.generate_headline_from_description(sender, instance, *args, **kwargs)[source]¶: Auto generate the headline of the node from the first lines of the description.

fiction_outlines.receivers.story_node_add_arc_element_update_characters_locations(sender, instance, created, *args, **kwargs)[source]¶: If an arc element is added to a story element node, add any missing elements or locations.

fiction_outlines.receivers.story_root_for_new_outline(sender, instance, created, *args, **kwargs)[source]¶: If a new instance of a Outline is created, also create the root node of the story tree.

fiction_outlines.receivers.validate_against_prohibited_actions(sender, instance, action, target_node_type=None, target_node=None, pos=None, *args, **kwargs)[source]¶

fiction_outlines.receivers.validate_arc_links_same_outline(sender, instance, *args, **kwargs)[source]¶: Evaluates attempts to link an arc to a story node from another outline.

fiction_outlines.receivers.validate_character_for_story_element(sender, instance, action, reverse, pk_set, *args, **kwargs)[source]¶: Validates that character is from the same outline as the story node.

fiction_outlines.receivers.validate_character_instance_valid_for_arc(sender, instance, action, reverse, pk_set, *args, **kwargs)[source]¶: Evaluate attempts to assign a character instance to ensure it is from same outline.

fiction_outlines.receivers.validate_generations_for_story_elements(sender, instance, action, target_node_type=None, target_node=None, pos=None, *args, **kwargs)[source]¶: Unlike arc nodes, for which we just warn about structure, the story tree allowed parent/child rules must be strictly enforced.

fiction_outlines.receivers.validate_location_for_story_element(sender, instance, action, reverse, pk_set, *args, **kwargs)[source]¶: Validates that location is from same outline as story node.

fiction_outlines.receivers.validate_location_instance_valid_for_arc(sender, instance, action, reverse, pk_set, *args, **kwargs)[source]¶: Evaluates attempts to add location instances to arc, ensuring they are from same outline.

fiction_outlines.signals module¶

Custom signals sent by this app.

Current list:

tree_manipulation: Sent when either the ArcElementNode or StoryElementNode trees have their structure manipulated.

fiction_outlines.urls module¶

URLs for fiction_outlines.

fiction_outlines.urls.path(route, view, kwargs=None, name=None, *, Pattern=<class 'django.urls.resolvers.RoutePattern'>)¶

fiction_outlines.views module¶

Views for fiction_outlines.

class fiction_outlines.views.ArcCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating an arc.

dispatch(request, *args, **kwargs)[source]¶

fields = ['name', 'mace_type']¶

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_context_data(**kwargs)[source]¶: Insert the form into the context dict.

get_permission_object()[source]¶: Override this method to provide the object to check for permission against. By default uses self.get_object() as provided by SingleObjectMixin. Returns None if there’s no get_object method.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.Arc

permission_required = 'fiction_outlines.edit_outline'¶

success_url = None¶

template_name = 'fiction_outlines/arc_create.html'¶

class fiction_outlines.views.ArcDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.DeleteView

Generic view for deleting an arc

context_object_name = 'arc'¶

dispatch(request, *args, **kwargs)[source]¶

get_success_url()[source]¶

model¶: alias of fiction_outlines.models.Arc

permission_required = 'fiction_outlines.delete_arc'¶

pk_url_kwarg = 'arc'¶

success_url = None¶

template_name = 'fiction_outlines/arc_delete.html'¶

class fiction_outlines.views.ArcDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for arc details.

context_object_name = 'arc'¶

dispatch(request, *args, **kwargs)[source]¶

get_context_data(**kwargs)[source]¶: Insert the single object into the context dict.

model¶: alias of fiction_outlines.models.Arc

permission_required = 'fiction_outlines.view_arc'¶

pk_url_kwarg = 'arc'¶

prefetch_related = ['arcelementnode_set']¶

select_related = ['outline']¶

template_name = 'fiction_outlines/arc_detail.html'¶

class fiction_outlines.views.ArcListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.list.ListView

Generic list view for arcs in a outline

context_object_name = 'arc_list'¶

dispatch(request, *args, **kwargs)[source]¶

get_context_data(**kwargs)[source]¶: Get the context for this view.

get_permission_object()[source]¶: Override this method to provide the object to check for permission against. By default uses self.get_object() as provided by SingleObjectMixin. Returns None if there’s no get_object method.

get_queryset()[source]¶

Return the list of items for this view.

The return value must be an iterable and may be an instance of QuerySet in which case QuerySet specific behavior will be enabled.

model¶: alias of fiction_outlines.models.Arc

permission_required = 'fiction_outlines.view_outline'¶

template_name = 'fiction_outlines/arc_list.html'¶

class fiction_outlines.views.ArcNodeCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Create view for an arc node. Assumes that the target position has already been passed to it via kwargs.

dispatch(request, *args, **kwargs)[source]¶

form_class¶: alias of fiction_outlines.forms.ArcNodeForm

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_permission_object()[source]¶: Override this method to provide the object to check for permission against. By default uses self.get_object() as provided by SingleObjectMixin. Returns None if there’s no get_object method.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.ArcElementNode

permission_required = 'fiction_outlines.edit_arc'¶

success_url = None¶

template_name = 'fiction_outlines/arcnode_create.html'¶

class fiction_outlines.views.ArcNodeDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

View for deleting an arc node.

context_object_name = 'arcnode'¶

delete(request, *args, **kwargs)[source]¶: Call the delete() method on the fetched object and then redirect to the success URL.

dispatch(request, *args, **kwargs)[source]¶

form_valid(form)[source]¶

get_success_url()[source]¶

model¶: alias of fiction_outlines.models.ArcElementNode

node_deletion_safe()[source]¶

permission_required = 'fiction_outlines.delete_arc_node'¶

pk_url_kwarg = 'arcnode'¶

prefetch_related = ['assoc_characters', 'assoc_locations']¶

select_related = ['arc', 'arc__outline', 'story_element_node']¶

success_url = None¶

template_name = 'fiction_outlines/arcnode_delete.html'¶

class fiction_outlines.views.ArcNodeDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

View for looking at the details of an atomic node as opposed to the whole tree.

context_object_name = 'arcnode'¶

model¶: alias of fiction_outlines.models.ArcElementNode

permission_required = 'fiction_outlines.view_arc_node'¶

pk_url_kwarg = 'arcnode'¶

prefetch_related = ['assoc_characters', 'assoc_locations']¶

select_related = ['arc', 'arc__outline', 'story_element_node']¶

template_name = 'fiction_outlines/arcnode_detail.html'¶

class fiction_outlines.views.ArcNodeMoveView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.UpdateView

View for executing a move method on an arcnode.

context_object_name = 'arcnode'¶

form_class¶: alias of django.forms.widgets.ArcElementNodeForm

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.ArcElementNode

permission_required = 'fiction_outlines.edit_arc_node'¶

pk_url_kwarg = 'arcnode'¶

success_url = None¶

template_name = 'fiction_outlines/arcnode_move.html'¶

class fiction_outlines.views.ArcNodeUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.UpdateView

View for editing details of an arc node (but not it’s tree position).

context_object_name = 'arcnode'¶

form_class¶: alias of fiction_outlines.forms.ArcNodeForm

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.ArcElementNode

permission_required = 'fiction_outlines.edit_arc_node'¶

pk_url_kwarg = 'arcnode'¶

prefetch_related = ['assoc_characters', 'assoc_locations']¶

select_related = ['arc', 'arc__outline', 'story_element_node']¶

success_url = None¶

template_name = 'fiction_outlines/arcnode_update.html'¶

class fiction_outlines.views.ArcUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, django.views.generic.edit.UpdateView

Generic view for updating arc details

context_object_name = 'arc'¶

fields = ['name', 'mace_type']¶

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.Arc

permission_required = 'fiction_outlines.edit_arc'¶

pk_url_kwarg = 'arc'¶

select_related = ['outline']¶

success_url = None¶

template_name = 'fiction_outlines/arc_update.html'¶

class fiction_outlines.views.CharacterCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating a character.

form_class¶: alias of fiction_outlines.forms.CharacterForm

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.Character

success_url = None¶

template_name = 'fiction_outlines/character_create.html'¶

class fiction_outlines.views.CharacterDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

Generic view for deleting a character.

context_object_name = 'character'¶

model¶: alias of fiction_outlines.models.Character

permission_required = 'fiction_outlines.delete_character'¶

pk_url_kwarg = 'character'¶

prefetch_related = ['series', 'characterinstance_set']¶

success_url = '/fiction-outlines/characters/'¶

template_name = 'fiction_outlines/character_delete.html'¶

class fiction_outlines.views.CharacterDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for character details.

context_object_name = 'character'¶

model¶: alias of fiction_outlines.models.Character

permission_required = 'fiction_outlines.view_character'¶

pk_url_kwarg = 'character'¶

prefetch_related = ['series', 'characterinstance_set', 'characterinstance_set__outline']¶

template_name = 'fiction_outlines/character_detail.html'¶

class fiction_outlines.views.CharacterInstanceCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Generic create view for a character instance.

dispatch(request, *args, **kwargs)[source]¶

form_class¶: alias of fiction_outlines.forms.CharacterInstanceForm

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_context_data(**kwargs)[source]¶: Insert the form into the context dict.

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

has_permission()[source]¶: Override this method to customize the way permissions are checked.

model¶: alias of fiction_outlines.models.CharacterInstance

outline = None¶

permission_required = None¶

success_url = None¶

template_name = 'fiction_outlines/character_instance_create.html'¶

class fiction_outlines.views.CharacterInstanceDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

Generic view for deleting character instances.

context_object_name = 'character_instance'¶

dispatch(request, *args, **kwargs)[source]¶

get_success_url()[source]¶

model¶: alias of fiction_outlines.models.CharacterInstance

permission_required = 'fiction_outlines.delete_character_instance'¶

pk_url_kwarg = 'instance'¶

prefetch_related = ['arcelementnode_set', 'storyelementnode_set']¶

select_related = ['character', 'outline']¶

success_url = None¶

template_name = 'fiction_outlines/character_instance_delete.html'¶

class fiction_outlines.views.CharacterInstanceDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic detail view for character instance.

context_object_name = 'character_instance'¶

dispatch(request, *args, **kwargs)[source]¶

get_permission_object()[source]¶: Override this method to provide the object to check for permission against. By default uses self.get_object() as provided by SingleObjectMixin. Returns None if there’s no get_object method.

model¶: alias of fiction_outlines.models.CharacterInstance

permission_required = 'fiction_outlines.view_character'¶

pk_url_kwarg = 'instance'¶

prefetch_related = ['arcelementnode_set', 'storyelementnode_set']¶

select_related = ['character', 'outline']¶

template_name = 'fiction_outlines/character_instance_detail.html'¶

class fiction_outlines.views.CharacterInstanceListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.list.ListView

Generic view for seeing a list of all character instances for a particular character.

context_object_name = 'character_instance_list'¶

dispatch(request, *args, **kwargs)[source]¶

get_context_data(**kwargs)[source]¶: Get the context for this view.

get_permission_object()[source]¶: Override this method to provide the object to check for permission against. By default uses self.get_object() as provided by SingleObjectMixin. Returns None if there’s no get_object method.

get_queryset()[source]¶

Return the list of items for this view.

The return value must be an iterable and may be an instance of QuerySet in which case QuerySet specific behavior will be enabled.

model¶: alias of fiction_outlines.models.CharacterInstance

permission_required = 'fiction_outlines.view_character'¶

template_name = 'fiction_outlines/character_instance_list.html'¶

class fiction_outlines.views.CharacterInstanceUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, django.views.generic.edit.UpdateView

Generic view for updating a character instance.

context_object_name = 'character_instance'¶

dispatch(request, *args, **kwargs)[source]¶

form_class¶: alias of fiction_outlines.forms.CharacterInstanceForm

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_permission_object()[source]¶: Override this method to provide the object to check for permission against. By default uses self.get_object() as provided by SingleObjectMixin. Returns None if there’s no get_object method.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.CharacterInstance

permission_required = 'fiction_outlines.edit_character'¶

pk_url_kwarg = 'instance'¶

select_related = ['character', 'outline']¶

success_url = None¶

template_name = 'fiction_outlines/character_instance_update.html'¶

class fiction_outlines.views.CharacterListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.list.ListView

Generic view for viewing character list.

context_object_name = 'character_list'¶

get_queryset()[source]¶

Return the list of items for this view.

The return value must be an iterable and may be an instance of QuerySet in which case QuerySet specific behavior will be enabled.

model¶: alias of fiction_outlines.models.Character

template_name = 'fiction_outlines/character_list.html'¶

class fiction_outlines.views.CharacterUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.UpdateView

Generic update view for character.

context_object_name = 'character'¶

form_class¶: alias of fiction_outlines.forms.CharacterForm

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.Character

permission_required = 'fiction_outlines.edit_character'¶

pk_url_kwarg = 'character'¶

prefetch_related = ['series']¶

success_url = None¶

template_name = 'fiction_outlines/character_update.html'¶

class fiction_outlines.views.LocationCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating locations

form_class¶: alias of fiction_outlines.forms.LocationForm

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_context_data(**kwargs)[source]¶: Insert the form into the context dict.

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.Location

success_url = None¶

template_name = 'fiction_outlines/location_create.html'¶

class fiction_outlines.views.LocationDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.DeleteView

Generic view for deleting locations.

context_object_name = 'location'¶

get_success_url()[source]¶

model¶: alias of fiction_outlines.models.Location

permission_required = 'fiction_outlines.delete_location'¶

pk_url_kwarg = 'location'¶

success_url = None¶

template_name = 'fiction_outlines/location_delete.html'¶

class fiction_outlines.views.LocationDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for location details.

context_object_name = 'location'¶

model¶: alias of fiction_outlines.models.Location

permission_required = 'fiction_outlines.view_location'¶

pk_url_kwarg = 'location'¶

prefetch_related = ['series', 'locationinstance_set', 'locationinstance_set__outline']¶

template_name = 'fiction_outlines/location_detail.html'¶

class fiction_outlines.views.LocationInstanceCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating a location instance on a outline.

dispatch(request, *args, **kwargs)[source]¶

form_class¶: alias of fiction_outlines.forms.LocationInstanceForm

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_context_data(**kwargs)[source]¶: Insert the form into the context dict.

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_permission_object()[source]¶: Override this method to provide the object to check for permission against. By default uses self.get_object() as provided by SingleObjectMixin. Returns None if there’s no get_object method.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.LocationInstance

permission_required = 'fiction_outlines.edit_location'¶

success_url = None¶

template_name = 'fiction_outlines/location_instance_create.html'¶

class fiction_outlines.views.LocationInstanceDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

Generic delete view for Location Instance.

context_object_name = 'location_instance'¶

dispatch(request, *args, **kwargs)[source]¶

get_success_url()[source]¶

model¶: alias of fiction_outlines.models.LocationInstance

permission_required = 'fiction_outlines.delete_location_instance'¶

pk_url_kwarg = 'instance'¶

prefetch_related = ['arcelementnode_set', 'storyelementnode_set']¶

select_releated = ['location', 'outline']¶

success_url = None¶

template_name = 'fiction_outlines/location_instance_delete.html'¶

class fiction_outlines.views.LocationInstanceDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for a location instance detail view.

context_object_name = 'location_instance'¶

dispatch(request, *args, **kwargs)[source]¶

get_permission_object()[source]¶: Override this method to provide the object to check for permission against. By default uses self.get_object() as provided by SingleObjectMixin. Returns None if there’s no get_object method.

model¶: alias of fiction_outlines.models.LocationInstance

permission_required = 'fiction_outlines.view_location'¶

pk_url_kwarg = 'instance'¶

prefetch_related = ['arcelementnode_set', 'storyelementnode_set']¶

select_related = ['location', 'outline']¶

template_name = 'fiction_outlines/location_instance_detail.html'¶

class fiction_outlines.views.LocationInstanceListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.list.ListView

Generic view for looking at all location instances for a location.

context_object_name = 'location_instance_list'¶

dispatch(request, *args, **kwargs)[source]¶

get_context_data(**kwargs)[source]¶: Get the context for this view.

get_permission_object()[source]¶: Override this method to provide the object to check for permission against. By default uses self.get_object() as provided by SingleObjectMixin. Returns None if there’s no get_object method.

get_queryset()[source]¶

Return the list of items for this view.

The return value must be an iterable and may be an instance of QuerySet in which case QuerySet specific behavior will be enabled.

model¶: alias of fiction_outlines.models.LocationInstance

permission_required = 'fiction_outlines.view_location'¶

template_name = 'fiction_outlines/location_instance_list.html'¶

class fiction_outlines.views.LocationInstanceUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, django.views.generic.edit.UpdateView

Generic view for updating a location instance. Not used since there are not details. But it’s here if you want to subclass LocationInstance and customize it.

context_object_name = 'location_instance'¶

dispatch(request, *args, **kwargs)[source]¶

form_class¶: alias of fiction_outlines.forms.LocationInstanceForm

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_context_data(**kwargs)[source]¶: Insert the form into the context dict.

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.LocationInstance

permission_required = 'fiction_outlines.edit_location_instance'¶

pk_url_kwarg = 'instance'¶

select_related = ['location', 'outline']¶

success_url = None¶

template_name = 'fiction_outlines/location_instance_update.html'¶

class fiction_outlines.views.LocationListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.list.ListView

Generic view for locations.

context_object_name = 'location_list'¶

get_queryset()[source]¶

Return the list of items for this view.

The return value must be an iterable and may be an instance of QuerySet in which case QuerySet specific behavior will be enabled.

model¶: alias of fiction_outlines.models.Location

template_name = 'fiction_outlines/location_list.html'¶

class fiction_outlines.views.LocationUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.UpdateView

Generic view for updating locations.

context_object_name = 'location'¶

form_class¶: alias of fiction_outlines.forms.LocationForm

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.Location

permission_required = 'fiction_outlines.edit_location'¶

pk_url_kwarg = 'location'¶

success_url = None¶

template_name = 'fiction_outlines/location_update.html'¶

class fiction_outlines.views.OutlineCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating initial outline.

form_class¶: alias of fiction_outlines.forms.OutlineForm

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.Outline

success_url = None¶

template_name = 'fiction_outlines/outline_create.html'¶

class fiction_outlines.views.OutlineDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.DeleteView

Generic delete view for an outline.

context_object_name = 'outline'¶

model¶: alias of fiction_outlines.models.Outline

permission_required = 'fiction_outlines.delete_outline'¶

pk_url_kwarg = 'outline'¶

success_url = '/fiction-outlines/outlines/'¶

template_name = 'fiction_outlines/outline_delete.html'¶

class fiction_outlines.views.OutlineDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for Outline detail

context_object_name = 'outline'¶

model¶: alias of fiction_outlines.models.Outline

permission_required = 'fiction_outlines.view_outline'¶

pk_url_kwarg = 'outline'¶

prefetch_related = ['arc_set', 'characterinstance_set', 'locationinstance_set', 'storyelementnode_set']¶

select_related = ['series']¶

template_name = 'fiction_outlines/outline_detail.html'¶

class fiction_outlines.views.OutlineExport(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view to get an export of an outline record.

Takes a url kwarg of outline as the pk of the fiction_outlines.models.Outline The url kwarg of format determines the type returned. Current supported formats are opml, json, or md.

context_object_name = 'outline'¶

default_format = 'json'¶

dispatch(request, *args, **kwargs)[source]¶

get_context_data(**kwargs)[source]¶: Insert the single object into the context dict.

model¶: alias of fiction_outlines.models.Outline

not_implemented(context, **response_kwargs)[source]¶: If DEBUG: raise NotImplemented Exception. If not, raise 404. :raises:`django.http.Http404` if production environment. :raises:`NotImplementedError` if settings.DEBUG is True

permission_required = 'fiction_outlines.view_outline'¶

pk_url_kwarg = 'outline'¶

prefetch_related = ['arc_set', 'storyelementnode_set', 'characterinstance_set', 'characterinstance_set__character', 'locationinstance_set', 'locationinstance_set__location', 'tags']¶

render_to_response(context, **response_kwargs)[source]¶

Compares requested format to supported formats and routes the response.

Attribute switcher:
	A dictionary of format types and their respective response methods.

return_json_response(context, **request_kwargs)[source]¶: Returns detailed outline structure as django.http.JsonResponse.

return_md_response(context, **response_kwargs)[source]¶: Returns the outline as a single markdown file.

return_opml_response(context, **response_kwargs)[source]¶: Returns export data as an opml file.

select_related = ['series', 'user']¶

template_name = 'fiction_outlines/outline.opml'¶

class fiction_outlines.views.OutlineListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.list.ListView

Generic view for Outline Outline list

context_object_name = 'outline_list'¶

get_queryset()[source]¶

Return the list of items for this view.

The return value must be an iterable and may be an instance of QuerySet in which case QuerySet specific behavior will be enabled.

model¶: alias of fiction_outlines.models.Outline

prefetch_related = ['arc_set', 'storyelementnode_set', 'characterinstance_set', 'locationinstance_set']¶

select_related = ['series']¶

template_name = 'fiction_outlines/outline_list.html'¶

class fiction_outlines.views.OutlineUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.UpdateView

Generic update view for outline details.

context_object_name = 'outline'¶

form_class¶: alias of fiction_outlines.forms.OutlineForm

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.Outline

permission_required = 'fiction_outlines.edit_outline'¶

pk_url_kwarg = 'outline'¶

success_url = None¶

template_name = 'fiction_outlines/outline_update.html'¶

class fiction_outlines.views.SeriesCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating series object.

fields = ['title', 'description', 'tags']¶

form_valid(form)[source]¶: Override to ensure we can add the user to the record.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.Series

success_url = None¶

template_name = 'fiction_outlines/series_create.html'¶

class fiction_outlines.views.SeriesDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.DeleteView

Generic view for deleting a series.

context_object_name = 'series'¶

model¶: alias of fiction_outlines.models.Series

permission_required = 'fiction_outlines.delete_series'¶

pk_url_kwarg = 'series'¶

success_url = '/fiction-outlines/series/'¶

template_name = 'fiction_outlines/series_delete.html'¶

class fiction_outlines.views.SeriesDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view to see series details.

context_object_name = 'series'¶

model¶: alias of fiction_outlines.models.Series

permission_required = 'fiction_outlines.view_series'¶

pk_url_kwarg = 'series'¶

prefetch_related = ['character_set', 'location_set', 'outline_set']¶

template_name = 'fiction_outlines/series_detail.html'¶

class fiction_outlines.views.SeriesListView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.list.ListView

Generic view for viewing a list of series objects.

context_object_name = 'series_list'¶

get_queryset()[source]¶

Return the list of items for this view.

The return value must be an iterable and may be an instance of QuerySet in which case QuerySet specific behavior will be enabled.

model¶: alias of fiction_outlines.models.Series

template_name = 'fiction_outlines/series_list.html'¶

class fiction_outlines.views.SeriesUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.UpdateView

Generic view for updating a series object.

context_object_name = 'series'¶

fields = ['title', 'description', 'tags']¶

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.Series

permission_required = 'fiction_outlines.edit_series'¶

pk_url_kwarg = 'series'¶

prefetch_related = ['character_set', 'location_set', 'outline_set']¶

success_url = None¶

template_name = 'fiction_outlines/series_update.html'¶

class fiction_outlines.views.StoryNodeCreateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Creation view for a story node. Assumes the target and pos have been passed as kwargs.

dispatch(request, *args, **kwargs)[source]¶

form_class¶: alias of fiction_outlines.forms.StoryNodeForm

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_permission_object()[source]¶: Override this method to provide the object to check for permission against. By default uses self.get_object() as provided by SingleObjectMixin. Returns None if there’s no get_object method.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.StoryElementNode

permission_required = 'fiction_outlines.edit_outline'¶

success_url = None¶

template_name = 'fiction_outlines/storynode_create.html'¶

class fiction_outlines.views.StoryNodeDeleteView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

Genric view for deleting a story node.

context_object_name = 'storynode'¶

dispatch(request, *args, **kwargs)[source]¶

get_success_url()[source]¶

model¶: alias of fiction_outlines.models.StoryElementNode

permission_required = 'fiction_outlines.delete_story_node'¶

pk_url_kwarg = 'storynode'¶

prefetch_related = ['arcelementnode_set', 'assoc_characters', 'assoc_locations']¶

select_related = ['outline']¶

success_url = None¶

template_name = 'fiction_outlines/storynode_delete.html'¶

class fiction_outlines.views.StoryNodeDetailView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

View for looking at the details of an atomic story node as opposed to the whole tree.

context_object_name = 'storynode'¶

model¶: alias of fiction_outlines.models.StoryElementNode

permission_required = 'fiction_outlines.view_story_node'¶

pk_url_kwarg = 'storynode'¶

prefetch_related = ['arcelementnode_set', 'assoc_characters', 'assoc_locations']¶

select_related = ['outline']¶

template_name = 'fiction_outlines/storynode_detail.html'¶

class fiction_outlines.views.StoryNodeMoveView(**kwargs)[source]¶

Bases: fiction_outlines.views.StoryNodeUpdateView

View for executing a move method on an arcnode.

form_class¶: alias of django.forms.widgets.StoryElementNodeForm

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

success_url = None¶

template_name = 'fiction_outlines/storynode_move.html'¶

class fiction_outlines.views.StoryNodeUpdateView(**kwargs)[source]¶

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.UpdateView

View for doing basic updates to a story node, but not regarding its position in the tree.

context_object_name = 'storynode'¶

form_class¶: alias of fiction_outlines.forms.StoryNodeForm

form_valid(form)[source]¶: If the form is valid, save the associated model.

get_form_kwargs()[source]¶: Return the keyword arguments for instantiating the form.

get_success_url()[source]¶: Return the URL to redirect to after processing a valid form.

model¶: alias of fiction_outlines.models.StoryElementNode

permission_required = 'fiction_outlines.edit_story_node'¶

pk_url_kwarg = 'storynode'¶

prefetch_related = ['arcelementnode_set', 'assoc_characters', 'assoc_locations']¶

select_related = ['outline']¶

success_url = None¶

template_name = 'fiction_outlines/storynode_update.html'¶

Module contents¶

fiction_outlines is a reusable Django app for managing manuscript outlines.

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/maceoutliner/django-fiction-outlines/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

Django Fiction Outlines could always use more documentation, whether as part of the official Django Fiction Outlines docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/maceoutliner/django-fiction-outlines/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up django-fiction-outlines for local development.

Fork the django-fiction-outlines repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/django-fiction-outlines.git

Install your local copy into a virtualenv. Assuming you have pipenv installed, this is how you set up your fork for local development:
```
$ cd django-fiction-outlines/
$ pipenv install --dev
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.

It is preferred and appreciated if you follow this style guide for your commit messages.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 fiction_outlines tests
$ pytest
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python for Python 3.5 and up. Check https://travis-ci.org/maceoutliner/django-fiction-outlines/pull_requests and make sure that the tests pass for all supported Python versions. (Don’t submit issues or PR to enable Python 2 support. They will not be merged.)
Where appropriate, squash your commits using git rebase -i.

Appropriate Conduct¶

All contributors and project participants are expected to follow our Contributor Covenant Code of Conduct.

Contributor Covenant Code of Conduct¶

Our Pledge¶

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards¶

Examples of behavior that contributes to creating a positive environment include:

Using welcoming and inclusive language
Being respectful of differing viewpoints and experiences
Gracefully accepting constructive criticism
Focusing on what is best for the community
Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

The use of sexualized language or imagery and unwelcome sexual attention or advances
Trolling, insulting/derogatory comments, and personal or political attacks
Public or private harassment
Publishing others’ private information, such as a physical or electronic address, without explicit permission
Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities¶

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope¶

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement¶

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at coc@maceoutliner.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.

Attribution¶

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

BSD License¶

The Clear BSD License

Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice,

this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright

notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of the copyright holder nor the names of its

contributors may be used to endorse or promote products derived from this software without specific prior written permission.

NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Credits¶

Development Lead¶

Daniel Andrlik <daniel@andrlik.org>

Contributors¶

None yet. Why not be the first?

History¶

0.4.0 (2022-03-17)¶

Now requires Django > 3.2. Compatible through Django 4.0
Compatible with Python 3.9 and 3.10.

0.3.1 (2018-10-16)¶

Now compatible with both Python 3.7 and 3.6

0.3.0 (2018-08-08)¶

Support for Django 2.1

0.2.2 (2018-04-19)¶

Bug fix: override model_utils until my submitted bug fix for created/modified timestamps is merged upstream.

0.2.1 (2018-04-14)¶

Add created and modified auto timestamps to all tree models.

0.2.0 (2018-04-13)¶

Add export functions. A view is provided for users to export outlines as either OPML, JSON, or Markdown documents.

0.1.5 (2018-04-09)¶

Improvements to length estimate calculation.
Improvements to test coverage.

0.1.4 (2018-04-07)¶

Hotfix release for tag field issue.

0.1.3 (2018-04-07)¶

Bugfix release for migrations

0.1.2 (2018-04-02)¶

Bugfix release.

0.1.1 (2018-04-01)¶

First release on PyPI.

Welcome to Django Fiction Outlines’s documentation!¶

Introduction¶

Documentation¶

Code Repo and Issue Tracker¶

License¶

Features¶

What It Doesn’t Do¶

Running Tests¶

Credits¶

Installation¶

Quickstart¶

Tutorial¶

Concepts¶

M.A.C.E. Quotient¶

Nesting¶

Seven Point Story Structure¶

Intro to fiction_outlines Models¶

First Tier Models¶

Second Tier Models¶

Usage¶

API¶

Models¶

Standard¶

Tree Models¶

Caveats¶

Signals¶

tree_manipulation¶

Receivers¶

Views¶

Forms¶

fiction_outlines¶

fiction_outlines package¶

Submodules¶

fiction_outlines.admin module¶

fiction_outlines.apps module¶

fiction_outlines.models module¶

fiction_outlines.receivers module¶

fiction_outlines.signals module¶

fiction_outlines.urls module¶

fiction_outlines.views module¶

Module contents¶

Contributing¶

Types of Contributions¶

Report Bugs¶

Fix Bugs¶

Implement Features¶

Write Documentation¶

Submit Feedback¶

Get Started!¶

Pull Request Guidelines¶

Appropriate Conduct¶

Contributor Covenant Code of Conduct¶

Our Pledge¶

Our Standards¶

Our Responsibilities¶

Scope¶

Enforcement¶

Attribution¶

BSD License¶

Credits¶

Development Lead¶

Contributors¶

History¶

0.4.0 (2022-03-17)¶

0.3.1 (2018-10-16)¶

0.3.0 (2018-08-08)¶

0.2.2 (2018-04-19)¶

0.2.1 (2018-04-14)¶

0.2.0 (2018-04-13)¶

0.1.5 (2018-04-09)¶

0.1.4 (2018-04-07)¶

0.1.3 (2018-04-07)¶

0.1.2 (2018-04-02)¶

0.1.1 (2018-04-01)¶

Intro to `fiction_outlines` Models¶