=====================
**License:** MIT
The intent of this project is to provide some very basic utilities related to Facebook.
At the moment there are only two features:
* An utility that forces the update of an URL in the Facebook's share cache.
* A Context Processor that allows you to hide Facebook [Open Graph Protocol](http://developers.facebook.com/docs/opengraphprotocol/) <meta> tags from other User Agents.
Installation
------------
`pip install django-facebook-utils`
or
`pip install git+http://github.com/caioariede/django-facebook-utils.git#egg=facebook_utils`
How to force an URL to be updated from Facebook's cache
-------------------------------------------------------
1. The `ping_facebook` command:
`python manage.py ping_facebook http://example.com`
See below **How to extend the ping_facebook command** to fit your needs.
2. Calling the `ping_facebook` shortcut:
from facebook_utils.shortcuts import ping_facebook
if ping_facebook('http://example.com'):
print('success')
else:
print('fail')
This shortcut will only return `True` or `False`. If you need more information to debug, you can call `facebook_utils.utils.ping` or use the `ping_facebook` command with `--verbosity=2` (more verbose).
Detecting Facebook requests
---------------------------
1. The `facebookexternalhit` context processor (for templates):
Add `facebook_utils.context_processors.facebookexternalhit` to the [TEMPLATE_CONTEXT_PROCESSOR](https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-TEMPLATE_CONTEXT_PROCESSORS) setting in `settings.py`:
TEMPLATE_CONTEXT_PROCESSORS = (
# .. other stuff
'facebook_utils.context_processors.facebookexternalhit',
)
In the template:
{% if facebookexternalhit %}
<meta property="og:title" content="The Rock"/>
<meta property="og:type" content="movie"/>
<meta property="og:url" content="http://www.imdb.com/title/tt0117500/"/>
<meta property="og:image" content="http://ia.media-imdb.com/rock.jpg"/>
{% endif %}
2. The `is_facebookexternalhit` shortcut:
from facebook_utils.shortcuts import is_facebookexternalhit
def some_view(request):
if is_facebookexternalhit(request):
return HttpResponse('Hello, Facebook!')
return HttpResponse('Hello visitor!')
How to extend the ping_facebook command
---------------------------------------
You can easily extend the `ping_facebook` command to fit your needs.
1. First of all, [start writing your own custom command](https://docs.djangoproject.com/en/dev/howto/custom-management-commands/).
2. Now extends the `ping_facebook` command:
from facebook_utils.management.commands import BasePingCommand
3. Finally, extend it to fit your needs:
class Command(BasePingCommand):
help = 'Ping some pages stored in database'
def handle(self, **options):
verbosity = options.get('verbosity')
traceback = options.get('traceback')
for page in Page.objects.all():
page_url = page.get_absolute_url()
self.do_ping(page_url, verbosity, traceback)
Metadata
Release files for django-facebook-utils 1.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| django-facebook-utils-1.0.4.tar.gz | 3.5 kB | Without provenance | Details for django-facebook-utils-1.0.4.tar.gz |
Release files / django-facebook-utils-1.0.4.tar.gz
| Download URL | django-facebook-utils-1.0.4.tar.gz |
|---|---|
| Size | 3.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
748f2e39354d8935b61d519b67445e2b139fe5568f7c356c3bb7232e751b8c9a
|
|
BLAKE2b-256 checksum How to use checksums |
0bbbfbae56125b32ae046b6a7aee36dbae609b9b1b6313f34dfa910eb6748aac
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for django-facebook-utils 1.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.