Welcome, Guest
Python Scripts for ComicRack

TOPIC: Searching for some API

Searching for some API 1 year 4 days ago #46549

  • L1
  • L1's Avatar
  • Offline
  • Fresh Boarder
  • Posts: 5
  • Karma: 0
Hi,

I've adapted one of the default scripts to export my collection in csv format [SaveCSVList]
I'd managed to add a few of the properties by looking at the wiki API reference but I want a bit more information, and I can't find how to do it anywhere [sorry if that was posted, I did try to find the information]
Here are the properties I'm looking for:
-
  • Series Complete
  • Series Books in the series
  • Series First and Last number of the series
  • Series Gaps

Those properties can be seen in the GUI (by selecting the columns) so I'm assuming I can access them through simple API, something like
book.Series.Gaps...

Any information on how to do that would be extremely helpfull
Last Edit: 1 year 4 days ago by L1. Reason: improved description
The administrator has disabled public write access.

Searching for some API 11 months 4 weeks ago #46577

  • L1
  • L1's Avatar
  • Offline
  • Fresh Boarder
  • Posts: 5
  • Karma: 0
Up! nobody has any idea ? is it even something we can acces through the API?
The administrator has disabled public write access.

Searching for some API 11 months 4 weeks ago #46581

  • boshuda
  • boshuda's Avatar
  • Offline
  • Gold Boarder
  • Posts: 296
  • Thank you received: 65
  • Karma: 8
book.SeriesCompleteAsText will return a string.
book.SeriesComplete will return a YesNo value ("from cYo.Projects.ComicRack.Engine import YesNo" first)
Keep in mind, this is the value as set by you. Not some metadata parsed from the series or something.

I spent a little time playing with the stuff below, and I think I'm missing something pretty fundamental to make use of them. More research would be necessary. I'm not sure how to hook into the following. I don't know if you can do it on a book and it will 'look up' the series, or if you can pass it a series or what. I suspect you would select all of the books in a series manually, then run it against the books hook, but I haven't tried anything out. The SeriesInfoPanel html plugin does seem to know when it's on a series as opposed to an individual book. You can probably look at the source code for that for concrete examples of how to use some of these fields.
GapCountAsText returns a string
GapCount returns an int
There's something called Gaps that might return something useful, but I really have no idea. There's a script that used to do the gaps for you a few versions ago. That might show you exactly what you want.
MaxCount returns an int
MinCount returns an int
MinNumberAsText returns a string
MaxNumberAsText returns a string
FirstNumber returns a float
LastNumber returns a float
The administrator has disabled public write access.

Searching for some API 11 months 4 weeks ago #46587

  • L1
  • L1's Avatar
  • Offline
  • Fresh Boarder
  • Posts: 5
  • Karma: 0
Thanks,
It is possible that the fields that you found are only available for a collection of books which mean that we need a method that return the series collection from one book and then we would be able to call those methods
one question for you: where/how did you find that those information exist? I have no clue (I'm not a python guy at all, I don't know how to use introspection in python properly). I would help to know what kind of object provides those fields
[for info: I'm talking about those fields: where did you find them? by looking to what object? :
  • GapCountAsText returns a string
  • GapCount returns an int
  • MaxCount returns an int
  • MinCount returns an int
  • MinNumberAsText returns a string
  • MaxNumberAsText returns a string
  • FirstNumber returns a float
  • LastNumber returns a float
Last Edit: 11 months 4 weeks ago by L1.
The administrator has disabled public write access.

Searching for some API 11 months 1 week ago #46698

  • Xelloss
  • Xelloss's Avatar
  • Offline
  • Platinum Boarder
  • Posts: 455
  • Thank you received: 117
  • Karma: 24
I don't know if this help... but here is the list of all book object attributes... I will try to see if I can make a script to show the types when I have some time...

'AddedTime'
'AddedTimeAsText'
'AgeRating'
'AgeRatingIcons'
'AlternateCaption'
'AlternateCount'
'AlternateCountAsText'
'AlternateNumber'
'AlternateNumberAsText'
'AlternateSeries'
'AppendArtistInfo'
'ArtistInfo'
'BlackAndWhite'
'BlackAndWhiteAsText'
'BookAge'
'BookChanged'
'BookCollectionStatus'
'BookCondition'
'BookLocation'
'BookNotes'
'BookOwner'
'BookPrice'
'BookPriceAsText'
'BookStore'
'BookmarkCount'
'BookmarkCountAsText'
'Bookmarks'
'Caption'
'CaptionWithoutFormat'
'CaptionWithoutTitle'
'Characters'
'Checked'
'ClearBookmarks'
'ClearExtraSyncInformation'
'ClipboardFormat'
'Clone'
'ColorAdjustment'
'ColorAdjustmentSpecified'
'Colorist'
'ComicInfoIsDirty'
'ComicProviderCreated'
'CommunityRating'
'CommunityRatingAsText'
'CompareAlternateNumber'
'CompareNumber'
'Container'
'CopyDataFrom'
'CopyFrom'
'CopyTo'
'Count'
'CountAsText'
'CoverArtist'
'CoverAsText'
'CoverKeyFilter'
'Create'
'CreateComicProvider'
'CreateFileHash'
'CreateImageProvider'
'CreateNavigator'
'CurrentPage'
'CurrentPageInfo'
'CustomThumbnailKey'
'CustomValuesStore'
'Day'
'DayAsText'
'Default'
'DefaultAlternateCaptionFormat'
'DefaultCaptionFormat'
'DefaultComicExportFileNameFormat'
'DeleteCustomValue'
'Deserialize'
'DeserializeFull'
'DisplayFileLocation'
'EditMode'
'Editor'
'EnableDynamicUpdate'
'EnableGroupNameCompression'
'EnableProposed'
'EnableProposedAsText'
'Equals'
'ExtraSyncInformation'
'FileCreationTime'
'FileCreationTimeAsText'
'FileDirectory'
'FileFormat'
'FileInfoRetrieved'
'FileIsMissing'
'FileLocation'
'FileModifiedTime'
'FileModifiedTimeAsText'
'FileName'
'FileNameWithExtension'
'FilePath'
'FileRenamed'
'FileSize'
'FileSizeAsText'
'FirstNonCoverPageIndex'
'Format'
'FormatDate'
'FormatFileDate'
'FormatIcons'
'FormatNumber'
'FormatPages'
'FormatRating'
'FormatString'
'FormatTitle'
'FormatVolume'
'FormatYear'
'FrontCoverCount'
'FrontCoverPageIndex'
'Genre'
'GetCustomValue'
'GetCustomValues'
'GetFrontCoverKey'
'GetFrontCoverThumbnailKey'
'GetFullTitle'
'GetHashCode'
'GetIcons'
'GetImageKey'
'GetImprintIconKey'
'GetInfo'
'GetIsoCulture'
'GetLanguageName'
'GetPage'
'GetPageByImageIndex'
'GetPageKey'
'GetPageList'
'GetProperties'
'GetPropertyValue'
'GetPublisherIconKey'
'GetStringPropertyValue'
'GetThumbnailKey'
'GetTranslatedWritableStringProperties'
'GetType'
'GetUntypedPropertyValue'
'GetWritableStringProperties'
'GetYesNoAsText'
'GuidEquality'
'HasBeenOpened'
'HasBeenRead'
'HasBeenReadAsText'
'Hash'
'ISBN'
'Id'
'Imprint'
'InfoText'
'Inker'
'IsDefaultPropertyValue'
'IsDefaultValue'
'IsDynamicSource'
'IsInContainer'
'IsLinked'
'IsLinkedAsText'
'IsSameContent'
'IsSearchable'
'IsValidComicBook'
'IsValidCoverKey'
'LanguageAsText'
'LanguageISO'
'LastOpenedFromListId'
'LastOpenedFromListIdSpecified'
'LastPageRead'
'LastPageReadAsText'
'Letterer'
'LoadFromSidecar'
'Locations'
'MainCharacterOrTeam'
'Manga'
'MangaAsText'
'MapPropertyName'
'MapPropertyNameToAsText'
'MarkAsNotRead'
'MarkAsRead'
'MemberwiseClone'
'Month'
'MonthAsText'
'MovePages'
'NewBooksChecked'
'NewPages'
'NewPagesAsText'
'NoText'
'Notes'
'Number'
'NumberAsText'
'NumberOnly'
'OnBookChanged'
'OnComicProviderCreated'
'OnCreateComicProvider'
'OnFileRenamed'
'OnNewComicPageAdded'
'OnParseFilePath'
'OpenProvider'
'OpenedCount'
'OpenedCountAsText'
'OpenedTime'
'OpenedTimeAsText'
'PageCount'
'Pages'
'PagesAsText'
'PagesAsTextSimple'
'ParseFilePath'
'ParseFilePathEventArgs'
'Penciller'
'PreferredFrontCover'
'ProposedCount'
'ProposedCountAsText'
'ProposedFormat'
'ProposedNakedVolumeAsText'
'ProposedNumber'
'ProposedNumberAsText'
'ProposedSeries'
'ProposedTitle'
'ProposedVolume'
'ProposedVolumeAsText'
'ProposedYear'
'ProposedYearAsText'
'Published'
'PublishedAsText'
'Publisher'
'PublisherIcons'
'Rating'
'RatingAsText'
'ReadPercentage'
'ReadPercentageAsRead'
'ReadPercentageAsText'
'ReferenceEquals'
'RefreshFileProperties'
'RefreshInfoFromFile'
'ReleasedTime'
'ReleasedTimeAsText'
'RemoveFromContainer'
'RenameFile'
'ResetInfoRetrieved'
'ResetPageSequence'
'ResetProperties'
'Review'
'ScanInformation'
'Serialize'
'SerializeFull'
'Series'
'SeriesComplete'
'SeriesCompleteAsText'
'SeriesEquals'
'SeriesGroup'
'SetCustomValue'
'SetFileLocation'
'SetInfo'
'SetPages'
'SetShadowValues'
'SetValue'
'ShadowCount'
'ShadowCountAsText'
'ShadowFormat'
'ShadowNumber'
'ShadowNumberAsText'
'ShadowSeries'
'ShadowTitle'
'ShadowVolume'
'ShadowVolumeAsText'
'ShadowYear'
'ShadowYearAsText'
'SortPages'
'SpecialIcons'
'Status'
'StoryArc'
'Summary'
'TR'
'Tags'
'TargetFilename'
'Teams'
'Title'
'ToArray'
'ToClipboard'
'ToString'
'ToXml'
'TranslateImageIndexToPage'
'TranslatePageToImageIndex'
'TrimExcessPageInfo'
'UpdateBookmark'
'UpdateDynamicPageCount'
'UpdatePageFileSize'
'UpdatePagePosition'
'UpdatePageRotation'
'UpdatePageSize'
'UpdatePageType'
'ValidateData'
'Volume'
'VolumeAsText'
'VolumeOnly'
'Web'
'Week'
'WeekAsText'
'WriteInfoToFile'
'WriteProposedValues'
'Writer'
'Year'
'YearAsText'
'YesRightToLeftText'
'YesText'

Some of them are suppose to be modifed, some of them not, and some of them can be even not values at all
Last Edit: 11 months 1 week ago by Xelloss.
The administrator has disabled public write access.
Time to create page: 0.219 seconds

Who's Online

We have 257 guests and 4 members online